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 621121 - GStreamer Plugin Writer's Guide needs to be updated
GStreamer Plugin Writer's Guide needs to be updated
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
unspecified
Other Linux
: Normal major
: 1.0.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-06-09 15:01 UTC by james.hodapp
Modified: 2012-09-28 23:27 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description james.hodapp 2010-06-09 15:01:56 UTC
There are several ways in which the guide needs to be updated. For example, in section 3.2 "Using the Project Stamp," there is a line that is inaccurate. "The last command creates two files: gstexamplefilter.c and gstexamplefilter.h." The make_element command should produce 2 files called gstmyfilter.c and gstmyfilter.h.

Another example is section 3.3 "Examining the Basic Code." The code listed is completely different than what make_element actually produces with the latest release. The same goes for section 3.4 "GstElementDetails."

Somebody simply needs to go through this guide and update each inaccurate or out-of-date line. This guide is very important for getting new developers going with GStreamer. I encountered these bugs while going through this guide for the company that I work at since I'll be developing some GStreamer elements for our product.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2010-07-03 21:21:35 UTC
I fully agree. If you can attach a patch as you already figured what changes it needs, that'd be great.
Comment 2 Josh Doe 2011-06-30 19:33:57 UTC
May as well add to the list of outdated portions of the PWG: 14.4.1 says source elements must send discontinuous events when starting/seeking, as of 0.10 this should be NEWSEGMENT.

http://gstreamer.freedesktop.org/data/doc/gstreamer/head/pwg/html/section-clock-obligations-of-each-element.html

I know I should attach a patch, but it seems someone more knowledgeable than myself should go through the entire guide and markup/fix things. Perhaps rather than being in git, PWG should be in a wiki to make editing trivial, and besides, there's precious little linking to the reference docs. Perhaps WikiBooks?

http://en.wikibooks.org/wiki/GStreamer
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2011-07-24 09:34:09 UTC
commit 3ebec93515331c16f6578ab31d98121f8b658776
Author: Stefan Kost <ensonic@users.sf.net>
Date:   Sun Jul 24 11:24:44 2011 +0200

    pwd: discontinous event -> newsegment event
    
    Fix a 0.8 leftover as mentioned on bug #621121.

I was thinking of wikibook too. We can even pull a pdf from it. Main problem is the initial import. We also like to merge the ADM and PWG. Maybe manual copy, paste and reformat is the way to do it.
Plan B for me is to use asciidoc and still have the book in the git repo. Would still be nice to have a mean to edit it online (there are attempts for wiki plugins that handle asciidoc).
Comment 4 Tim-Philipp Müller 2012-09-28 23:27:50 UTC
Wim has been going over the entire PWG recently to fix it up for 1.0. I'm sure he's not fixed every single thing, but a lot of things, eg. the clock section mentioned in comment #2.

commit 91a20a90eb11166cbbcbe848f7c0000ac3ac63c8
Author: Wim Taymans <wim.taymans@collabora.co.uk>
Date:   Fri Sep 28 16:03:15 2012 +0200

    pwg: update for 1.0
    
    Rewrite clock part.
    start on interfaces

commit 51492812cf864708129d263523ca9cd46d702984
Author: Tim-Philipp Müller <tim@centricular.net>
Date:   Sat Sep 29 00:27:03 2012 +0100

    pwg: minor update
    
    https://bugzilla.gnome.org/show_bug.cgi?id=621121



I don't think it's particularly useful to keep a general 'someone needs to go over the entire thing and update it' bug open. If there are specific issues, it's best to file bugs for those specific issues. That's much more likely to get fixed. Thanks!