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 133495 - [docs/man] man pages are not in sync with tools
[docs/man] man pages are not in sync with tools
Status: RESOLVED OBSOLETE
Product: GStreamer
Classification: Platform
Component: documentation
git master
Other opensolaris
: Normal normal
: NONE
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks: 133494
 
 
Reported: 2004-02-05 12:28 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2006-03-22 09:04 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docbook man pages for all tools from Brian Cameron (Sun) (12.35 KB, application/x-gzip)
2005-01-11 21:42 UTC, Stephane Loeuillet
Details

Description Stefan Sauer (gstreamer, gtkdoc dev) 2004-02-05 12:28:49 UTC
e.g. gst-register has options that are not in the man-page and the man page
have old options (degugging stuff) documented that does not exist in this
form anymore in the tools.

This applies to other tools as well (gst-launch -t -T)

Further please add to the docs of :
gst-register that the default location of the registry is under
$prefix/var/cache/gstreamer/registry.xml
gst-compprep that the default location of the completion is under
$prefix/var/cache/gstreamer/compreg.xml
Both entries should go to a FILES section.
Comment 1 Stephane Loeuillet 2005-01-11 21:42:33 UTC
Created attachment 35855 [details]
docbook man pages for all tools from Brian Cameron (Sun)

he posted them on gst-devel ML on 17 Sep 2004
but as they're in docbook and not std nroff format, they were never commited

letting them in docbook format would require docbook2man/db2man to transform
them
Comment 2 Andy Wingo 2005-07-15 08:48:18 UTC
Thomas, do you mind requiring docbook stuff in the build, or would you prefer
keeping it as nroff?
Comment 3 Tim-Philipp Müller 2006-03-21 15:34:25 UTC
This is pretty much obsolete, isn't it?

The man pages have had some updating AFAIK (and a good bunch have been removed along with some of the tools). A FILES section has been added to the gst-launch man page now as well.

Please re-open if there's still something that applies to 0.10 or you've got updated docbook man pages available (better check with Thomas first though if that entails any work).
Comment 4 Loïc Minier 2006-03-22 08:07:52 UTC
Tim, A Costa reporter three typos in the gst-launch manpage, two of which are fixed, the third one being:
-Sets the requested property in capabilites. The name is an alphanumeric value
+Sets the requested property in capabilities. The name is an alphanumeric value

:%s/capabilites/capabilities

But perhaps I forwarded that in another bug.
Comment 5 Loïc Minier 2006-03-22 08:11:14 UTC
(Hmm for some reason, this was in bug 133494, but I didn't mention that capabilities typo.)
Comment 6 Tim-Philipp Müller 2006-03-22 09:04:29 UTC
Thanks, fixed as well now. Must have missed it.