[gst-devel] gstreamer application developer and plugin writer manuals

Stefan Kost ensonic at hora-obscura.de
Wed Feb 1 14:45:13 CET 2006


I withdraw my proposal to unify some stuff in the docs, because the
docs-build system is quite borked^H^H^H^H^Hstrange :(
The build setup copies files around and stuff, so using shared files is
not a trivial thing to do. Too bad I only noticed this after rearranging
section for over three hours :(
I've added a note to the README to save others the trouble. There wasn't
any interest in better docs anyway ...


Stefan Kost wrote:
> hi all,
> I like to spend some time going over out development manuals
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/index.html
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/pwg/html/index.html
> First goal 1 is to prepare a list on
> http://live.gnome.org/GStreamerDocsTriage
> for these manuals, conatinig the section in doubt.
> Second I like to do something about the duplication in the introduction.
> I like both documents to start with chapter like this:
> I Introduction
>   1 Who should read this document?
>   2 Preliminary reading
>   3 Structure of this document
> II GStreamer concepts
>   GStreamer (will contain 'Motivation & Goals' from the manual)
>   Elements
>   Bins and pipelines
>   Pads and Caps
>   Buffers
>   Events
>   Metadata (Tags)
>   ... (probably more to add)
> Then both guide will continue with application/plugin specific docs:
> III Building an application (was Basic Concepts)
> III Building a plugin
> The part 'II GStreamer concepts' should be identical for both.
> Therefore I'd like to add directory under docs, say 'concepts' and put
> there files there. Both guides will then just reference them from there.
> Pros and cons?
> Stefan

More information about the gstreamer-devel mailing list