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 608127 - Application Development Manual inconsistent about return value of GstBusFunc
Application Development Manual inconsistent about return value of GstBusFunc
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
git master
Other Linux
: Normal normal
: 0.10.26
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-01-26 08:12 UTC by Robin Sonefors (ozamosi)
Modified: 2010-01-26 11:59 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Robin Sonefors (ozamosi) 2010-01-26 08:12:14 UTC
In the application development manual, in the document gstreamer/docs/manual/basics-bus.xml, it says that "The return value of the handler should be TRUE to remove the message from the bus" when explaining what a message handler added with gst_bus_add_watch () does.

According to a comment in the code sample further down in the same document, and the documentation for both gst_bus_add_watch and GstBusFunc, the return value does not control whether the message should be removed from the bus or not, but rather whether the handler should receive more messages or not.
Comment 1 Thiago Sousa Santos 2010-01-26 11:59:53 UTC
Fixed with this commit. Will be updated online soon.

Module: gstreamer
Branch: master
Commit: 69e23983a4e00c7236d2211005fa74a47790ff8e
URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=69e23983a4e00c7236d2211005fa74a47790ff8e

Author: Thiago Santos <thiago.sousa.santos@collabora.co.uk>
Date:   Tue Jan 26 08:52:16 2010 -0300

docs: Fix basics-bus docs

Fix wrong information about bus watch functions in the
application development manual.

Fixes #608127