After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 791588 - docs: GstBus: Adding missing docs and fix errors
docs: GstBus: Adding missing docs and fix errors
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
1.x
Other Linux
: Normal normal
: 1.13.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2017-12-13 18:21 UTC by Umang Jain
Modified: 2017-12-14 09:40 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: GstBus: Provide more information regarding reference counts. (1.48 KB, patch)
2017-12-13 18:35 UTC, Umang Jain
none Details | Review
docs: GstBus: Provide more information for ref/unref during bus watch (1.54 KB, patch)
2017-12-13 19:02 UTC, Umang Jain
committed Details | Review

Description Umang Jain 2017-12-13 18:21:18 UTC
Few docs improvements
Comment 1 Umang Jain 2017-12-13 18:35:41 UTC
Created attachment 365506 [details] [review]
docs: GstBus: Provide more information regarding reference counts.
Comment 2 Tim-Philipp Müller 2017-12-13 18:47:13 UTC
Comment on attachment 365506 [details] [review]
docs: GstBus: Provide more information regarding reference counts.

Thanks for the docs patch!

I think it might be even better if it was phrased slightly differently, something like: "The bus watch will take its own reference to @bus, so it is safe to unref @bus after setting up the bus watch" or somesuch?

Because it's not really the *function* that takes the ref, what you want to express is that the lifetime of that bus ref is linked to the bus watch, no?
Comment 3 Umang Jain 2017-12-13 18:52:45 UTC
> Because it's not really the *function* that takes the ref, what you want to
> express is that the lifetime of that bus ref is linked to the bus watch, no?

Correct. Yes, it's not *the function* that takes the ref but it's later in the call chain. Thanks for reviewing :) I'll update it quickly.
Comment 4 Umang Jain 2017-12-13 19:02:08 UTC
Created attachment 365507 [details] [review]
docs: GstBus: Provide more information for ref/unref during bus watch
Comment 5 Tim-Philipp Müller 2017-12-14 09:40:06 UTC
Thanks!

commit 52d2891fe3dea20969bfe5a5791e33d78a4c771d (HEAD -> master)
Author: Umang Jain <mailumangjain@gmail.com>
Date:   Thu Dec 14 00:03:04 2017 +0530

    docs: GstBus: Provide more information for ref/unref during bus watch.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=791588