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 323798 - obsolescences in online plugins doc (http://gstreamer.freedesktop.org/documentation/plugins.html)
obsolescences in online plugins doc (http://gstreamer.freedesktop.org/documen...
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
0.10.0
Other All
: Normal normal
: NONE
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2005-12-11 16:23 UTC by Benjamin Pineau
Modified: 2006-04-01 13:54 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Benjamin Pineau 2005-12-11 16:23:21 UTC
On http://gstreamer.freedesktop.org/documentation/plugins.html :

- half of the table's left column links are deads links

- most plugin's description pages have a dead link named "Unknown package
origin" as "origin". For instance on :
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/gst-plugins-good-plugins-plugin-cacasink.html

- plugin audiotestsrc
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-audiotestsrc.html
refers, on an example, to "libvisual_lv_scope" that isn't anymore an
valid element.

- plugin video4linux
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-plugin-video4linux.html
says "v4lsrc Reads raw frames from a video4linux (BT8x8) device", but
actually v4l can handle many non bt848/878 devices (like webcams etc) (or can
it ?)

- plugin audioconvert:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-audioconvert.html
all examples refers to an unknown element, "sinesrc".

- plugin goom
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/gst-plugins-good-plugins-goom.html
example refers to 'sinesrc'.

- plugin volume
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-volume.html
example refers to 'sinesrc'.

- plugin vorbisenc
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-vorbisenc.html
example refers to 'sinesrc'.

- Some plugins are forgotten (not indexed on this page).
I've found the following missing:
xshm (gst-plugins-base)
cdparanoia (gst-plugins-base)
ladspa (gst-plugins-good)
videofilter (gst-plugins-good)
musepack (gst-plugins-bad)
libmms (gst-plugins-bad)
ivorbisdec (gst-plugins-bad)
wavpack (gst-plugins-bad)
mpegstream (gst-plugins-ugly)
sidplay (gst-plugins-ugly)
Comment 1 Tim-Philipp Müller 2005-12-11 20:50:09 UTC
Fixed some of the references to sinesrc in CVS, some have already been fixed
(only the docs haven't been updated it seems).




Remaining issues (to make it easier):

(1)
On http://gstreamer.freedesktop.org/documentation/plugins.html :
- half of the table's left column links are deads links

(2)
- most plugin's description pages have a dead link named "Unknown package
origin" as "origin". For instance on :
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/gst-plugins-good-plugins-plugin-cacasink.html

(3)
- plugin audiotestsrc
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-audiotestsrc.html
refers, on an example, to "libvisual_lv_scope" that isn't anymore an
valid element.

tpm: libvisual_lv_scope is a valid plugin name, but the example pipeline from
the audiotestsrc docs still doesn't work

(4)
- plugin video4linux
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/gst-plugins-base-plugins-plugin-video4linux.html
says "v4lsrc Reads raw frames from a video4linux (BT8x8) device", but
actually v4l can handle many non bt848/878 devices (like webcams etc) (or can
it ?)


(5)
- Some plugins are forgotten (not indexed on this page).
I've found the following missing:
xshm (gst-plugins-base)
cdparanoia (gst-plugins-base)
ladspa (gst-plugins-good)
videofilter (gst-plugins-good)
musepack (gst-plugins-bad)
libmms (gst-plugins-bad)
ivorbisdec (gst-plugins-bad)
wavpack (gst-plugins-bad)
mpegstream (gst-plugins-ugly)
sidplay (gst-plugins-ugly)

Comment 2 Thomas Vander Stichele 2006-04-01 13:54:21 UTC
for (1), I added a note to the page that explains why some links are broken.  Unfortunately there is no good way for xslt to know that a link will be broken.

for (2), I changed the xslt code to only create a link if the origin starts with http

for (3), example fixed by adding queues

for (4), fixed

for (5):
- there is no xshm plugin
- cdparanoia was added some time ago
- ladspa has been added now
- there is no videofilter; the plugins in that directory are all listed
- mpegstream has been added
- sidplay doesn't load for me, missing symbols, C++ abi problem, opening different bug for that (#336835)
- for the plugins from bad, this is because nobody has them built and then added to the docs.  Don't expect all plugins from bad to be documented.

So, I think everything in the bug has been addressed adequately.  If you feel this is not the case, reopen, or maybe create separate bugs for it.