Commit graph

51 commits

Author SHA1 Message Date
Thibault Saunier
d1c79fc177 docs: Remove design doc as they have been moved to gst-docs
https://bugzilla.gnome.org/show_bug.cgi?id=775667
2016-12-06 14:08:14 -03:00
Tim-Philipp Müller
6f4891e26f docs: remove more docbook build cruft that's no longer needed 2016-11-14 21:18:13 +00:00
Tim-Philipp Müller
d4f4707eda docs: remove FAQ which was moved into gst-docs module 2016-11-14 17:46:07 +00:00
Tim-Philipp Müller
81a69d956d docs: remove app dev manual and plugin writer's guide
They have moved to gst-docs and will be maintained there in future.
2016-11-01 17:55:54 +00:00
Tim-Philipp Müller
eee7aa5f15 docs: enable parallel build of subdirectories
We can build gtk docs, ADM, PWG and FAQ in parallel.
2014-02-09 16:47:53 +00:00
Sebastian Rasmussen
249a775d2b docs: add missing files for distribution
* add some documentation files in docs/design
 * add docs/list-ulink.xsl so check in docs/manual works

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=719814
2013-12-03 23:50:36 +00:00
Stefan Kost
7407326abb docs/: Change to xinclude based build - its faster and easier to maintain.
Original commit message from CVS:
* docs/Makefile.am:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/gst/running.xml:
* docs/libs/gstreamer-libs-docs.sgml:
Change to xinclude based build - its faster and easier to maintain.
2008-10-30 15:29:51 +00:00
Felipe Contreras
3078614232 docs/Makefile.am: Fix installing plugin documentation when gtk-doc is disabled.
Original commit message from CVS:
* docs/Makefile.am:
Fix installing plugin documentation when gtk-doc is disabled.
2008-05-21 15:54:28 +00:00
Jan Schmidt
450fa6366a docs/Makefile.am: Don't descend into the plugins dir if plugin docs building is disabled.
Original commit message from CVS:
* docs/Makefile.am:
Don't descend into the plugins dir if plugin docs building
is disabled.
* docs/README:
Add a note about the new type:GTypeName syntax for the plugin
documentation .types file.
2008-05-17 17:20:51 +00:00
David Schleef
ffcc7dc992 docs/Makefile.am: the gtk-doc makefile snippet correctly handles the case when ENABLE_GTK_DOC is false, and installs ...
Original commit message from CVS:
* docs/Makefile.am: the gtk-doc makefile snippet correctly
handles the case when ENABLE_GTK_DOC is false, and installs
the prebuilt documentation.  So gtk-doc subdirs are
unconditionally enabled.  Fixes: #349099.
2007-05-13 20:28:14 +00:00
Tim-Philipp Müller
fa5953d31c autogen.sh: Add default for new --enable-plugin-docs switch.
Original commit message from CVS:
* autogen.sh:
Add default for new --enable-plugin-docs switch.
* configure.ac:
Use new GST_PLUGIN_DOCS macro to check for pyxml etc.
Fixes #344039.
* docs/Makefile.am:
Use new ENABLE_PLUGIN_DOCS conditional.
2006-06-16 08:30:47 +00:00
Thomas Vander Stichele
3795e5a571 move upload.mak to common
Original commit message from CVS:
* common/Makefile.am:
* docs/Makefile.am:
* docs/faq/Makefile.am:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
* docs/manual/Makefile.am:
* docs/plugins/Makefile.am:
* docs/pwg/Makefile.am:
* docs/slides/Makefile.am:
* docs/upload.mak:
* common/upload.mak:
move upload.mak to common
2006-04-29 00:36:47 +00:00
Loïc Minier
323c4ca50e Patch from Loïc Minier to prevent CVS directories getting disted.
Original commit message from CVS:
* configure.ac:
* docs/Makefile.am:
* docs/slides/Makefile.am:
Patch from Loïc Minier to prevent CVS directories getting disted.
2006-02-27 15:43:10 +00:00
Tim-Philipp Müller
6305357090 docs/design/Makefile.am
Original commit message from CVS:
* configure.ac:
* docs/Makefile.am:
* docs/design/Makefile.am
Dist design docs.
2006-02-09 18:28:33 +00:00
Thomas Vander Stichele
c37fca4fd4 document core plugins in a separate document just like all the others rename these plugins to something starting with...
Original commit message from CVS:
document core plugins in a separate document just like all the
others
rename these plugins to something starting with core
2005-12-01 12:29:34 +00:00
Thomas Vander Stichele
0a0d29d1b5 docs/: add a chapter on running GStreamer.
Original commit message from CVS:

* docs/Makefile.am:
* docs/gst/Makefile.am:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/running.xml:
* docs/version.entities.in:
add a chapter on running GStreamer.
document GST_DEBUG and GST_PLUGIN* env vars
2005-10-08 11:12:26 +00:00
Thomas Vander Stichele
50a2f3fb6f clean up docs build a little; have docdir be an overridable install location; separate gtk-doc and docbook bits
Original commit message from CVS:
clean up docs build a little; have docdir be an overridable install location; separate gtk-doc and docbook bits
2005-09-03 13:49:49 +00:00
Thomas Vander Stichele
bba6ac4b74 docs/: restructure so that common stuff is shown first
Original commit message from CVS:
* docs/Makefile.am:
* docs/manual/elements-api.xml:
restructure so that common stuff is shown first
* docs/manual/init-api.xml:
convert to examples
* docs/manual/manual.xml:
* docs/manuals.mak:
* docs/url.entities:
link to API on the website, possibly override later in build
* examples/manual/.cvsignore:
ignore more
* examples/manual/Makefile.am:
add more examples
* examples/manual/extract.pl:
error out on failure
2004-09-08 23:18:55 +00:00
Thomas Vander Stichele
55b67f084d fix non-validating docbook make sure validation gets checked before building
Original commit message from CVS:
fix non-validating docbook
make sure validation gets checked before building
2004-01-29 17:25:18 +00:00
Thomas Vander Stichele
1ad4c7a804 make upload work for both gtk-doc and docbook docs
Original commit message from CVS:
make upload work for both gtk-doc and docbook docs
2004-01-28 12:16:51 +00:00
Benjamin Otte
385b9ee5c4 merge in tagging
Original commit message from CVS:
merge in tagging
Includes:
- gsttag.[ch] - The definition of GstTagList and tag registering/querying
- gsttaginterface.[ch] - Interface for elements that can handle setting of tags
- updates and merges to gststructure.[ch] and gstvalue.[ch]
- testsuite/tags - some tests for tagging
- bugfixes
- updates to make make distcheck work
- updates the version number to 0.7.2.1

Does not include:
- including tagging stuff in docs
- extensive tests
2003-11-24 02:09:23 +00:00
Christian Schaller
b4f14a29f6 re-add the disting of the docs. more fixes to come
Original commit message from CVS:
re-add the disting of the docs. more fixes to come
2003-11-23 15:09:41 +00:00
Christian Schaller
08ded8cb40 misc build fixes to make cvs head build from tarballs on Fedora
Original commit message from CVS:
misc build fixes to make cvs head build from tarballs on Fedora
2003-11-22 22:06:30 +00:00
Thomas Vander Stichele
cbdc23d67f cleaning output
Original commit message from CVS:
cleaning output
2003-10-09 13:10:54 +00:00
Thomas Vander Stichele
90184bb1af upload cvs docs as well
Original commit message from CVS:
upload cvs docs as well
2003-10-09 13:06:06 +00:00
Thomas Vander Stichele
e44c8f032b entitize the version
Original commit message from CVS:
entitize the version
2003-10-08 18:21:41 +00:00
Thomas Vander Stichele
7d4cb79ffb fix docs build for good
Original commit message from CVS:
fix docs build for good
2003-10-08 14:34:09 +00:00
David Schleef
7b38bc69a3 Make docs building dependent on BUILD_DOCS, this appears to be what is intended by configure.ac.
Original commit message from CVS:
Make docs building dependent on BUILD_DOCS, this appears to be what
is intended by configure.ac.
2003-07-29 03:05:59 +00:00
Thomas Vander Stichele
50251fcfec converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno...
Original commit message from CVS:
converting to xml as intermediary step to fix devhelp generation
assorted doc build fixes as well
http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
Thomas Vander Stichele
df97a90209 faq
Original commit message from CVS:
faq
2002-10-19 09:20:13 +00:00
Leif Johnson
622a80da54 Moved "Filter Writer's Guide" to "Plugin Writer's Guide". Divided existing info from old guide into several files, on...
Original commit message from CVS:
Moved "Filter Writer's Guide" to "Plugin Writer's Guide". Divided existing info
from old guide into several files, one per chapter. The guide still needs much
work ...
2002-09-27 18:34:33 +00:00
Thomas Vander Stichele
43a68fd149 merged back fixes from release branch
Original commit message from CVS:
merged back fixes from release branch
2002-04-15 09:21:14 +00:00
Thomas Vander Stichele
5678e50a9a more docs fixing
Original commit message from CVS:
more docs fixing
2002-03-03 16:53:25 +00:00
David I. Lehn
818baa5c2c Generate m4 and xsl Makefiles
Original commit message from CVS:
Generate m4 and xsl Makefiles
Add xsl dir and *.xsl to dist
2002-01-09 03:03:26 +00:00
Richard Boulton
bbed116d90 Added plugins to DIST_SUBDIRS
Original commit message from CVS:
Added plugins to DIST_SUBDIRS
2001-06-25 20:39:53 +00:00
Richard Boulton
d80375c632 Added --enable-plugin-docs configure option, to enable build of the plugin documentation (currently broken). This de...
Original commit message from CVS:
Added --enable-plugin-docs configure option, to enable build of the plugin
documentation (currently broken).  This defaults to off.
Changed --enable-docs-build to default to on, since all other documentation
should build correctly.

Also, correct typo in manual, and fix up a couple of things in example.c
2001-03-20 23:12:24 +00:00
Wim Taymans
f37f8a939e Added directories to Makefiles for DIST
Original commit message from CVS:
Added directories to Makefiles for DIST
2001-02-24 16:56:19 +00:00
Wim Taymans
2a4a536fee Manual updates. fixes to gstxml.c gst_xml_get_element was broken
Original commit message from CVS:
Manual updates.
fixes to gstxml.c gst_xml_get_element was broken
2001-01-08 22:08:40 +00:00
Richard Boulton
13ece6af49 Don't delete CVS directories from working directory: delete from distdir.
Original commit message from CVS:
Don't delete CVS directories from working directory: delete from distdir.
Also, delete backup files, while you're at it. :)
2001-01-02 22:52:30 +00:00
Richard Boulton
71bb06d585 Add dist-hook to stop CVS/ directories being put into distribution.
Original commit message from CVS:
Add dist-hook to stop CVS/ directories being put into distribution.
2001-01-02 14:35:39 +00:00
Richard Boulton
c8e92c77d8 Added checking for all the tools used to make documentation.
Original commit message from CVS:
Added checking for all the tools used to make documentation.
If documentation cannot be generated, whatever is available will still be
installed.
videosink/imagetest is now a check_PROGRAM
2001-01-02 01:33:01 +00:00
Richard Boulton
550abf46a2 Add docs/fwg to DIST_SUBDIRS
Original commit message from CVS:
Add docs/fwg to DIST_SUBDIRS
2000-12-31 15:19:12 +00:00
Richard Boulton
75ac013312 Added framework for writing filter writers guide.
Original commit message from CVS:
Added framework for writing filter writers guide.
Extracted much of the makefile from docs/manual into a shared file which
is included, so it can be re-used.
2000-12-30 15:36:24 +00:00
Wim Taymans
894215eb29 Documentation updates documented the libraries
Original commit message from CVS:
Documentation updates
documented the libraries
2000-10-22 16:27:21 +00:00
Richard Boulton
f1d8e760fb Added building of the manual to the build system. Currently in a rudimentary state - will not gracefully give up if ...
Original commit message from CVS:
Added building of the manual to the build system.  Currently in a
rudimentary state - will not gracefully give up if tools not available,
will not uninstall / clean, and may not install / make dist properly.
Documentation does not have dependencies on images, so won't rebuild if
they're altered either.
2000-10-09 00:34:21 +00:00
Wim Taymans
d6e6b9cb60 Build fixes.
Original commit message from CVS:
Build fixes.
Adapted the test directory to the new state management
added an mpeg2 to avi encoder.
added a v4l to divx capture example.
2000-08-14 15:17:24 +00:00
Erik Walthinsen
b6d31c1c72 Megapatch, changes which states are available, how they're used, and how they're set. Also modifies the scheduling s...
Original commit message from CVS:
Megapatch, changes which states are available, how they're used, and how
they're set.  Also modifies the scheduling system, breaking pulled
buffers.  Check mail archives for more details.
2000-07-17 17:14:15 +00:00
Wim Taymans
bf8c785fb0 Documentation updates. All standard library objects and standard elements are documented. Modified some of the elemen...
Original commit message from CVS:
Documentation updates. All standard library objects and standard
elements are documented. Modified some of the elements to more
accuratly report about their arguments so the documentation builds
more reasonable output.
Added aviencoder and jpegencoder elements (not working yet)
2000-03-27 19:53:43 +00:00
Erik Walthinsen
65e7c2e158 More documentation changes, a couple configure.in and Makefile.am fixes.
Original commit message from CVS:
More documentation changes, a couple configure.in and Makefile.am fixes.
2000-02-02 06:26:44 +00:00
Erik Walthinsen
56a79fbfcc Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system.  I'd managed to mutilate it a while back,
but now it's fixed.  I'll put a copy of the HTML output somewhere on the
website tonight.

In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs.  (see
http://developer.gnome.org/arch/doc/tools.html)

Notes (I'll codify these some day):

- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file.  However, gtk-doc's merge and CVS's diff are
two entirely separate animals.  We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book.  There'd be another called docs/manual/, and
another docs/plugins/, etc.  If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00