Commit Graph

43 Commits

Author SHA1 Message Date
Diego Biurrun
8c201dde0a build: doc: more fine-grained dependencies for generated texi files 2016-09-15 21:37:16 +02:00
Anton Khirnov
990e4a6639 Add a QSV decoding example. 2015-02-28 21:51:24 +01:00
Anton Khirnov
e7dfaf16a4 libavfilter: example audio filtering program
Based on a patch by Andrew Kelley <superjoe30@gmail.com>

Signed-off-by: Diego Biurrun <diego@biurrun.de>
2014-02-25 13:22:10 +01:00
Diego Biurrun
b339182eba Move all example programs to doc/examples
Also drop support for building examples in library directories.
2014-02-16 21:37:21 +01:00
Diego Biurrun
3a26ccbf0d build: doxy: Include code examples in Doxygen documentation 2014-02-14 12:01:35 +01:00
Diego Biurrun
f1f42cfc66 build: Do not pass HTML snippets and stylesheet as input to Doxygen
These files are referenced elsewhere and only generate warnings if
presented to Doxygen as input files.
2014-02-14 12:01:35 +01:00
Christophe Gisquet
682b2a809b build: fix examples compilation when EXESUF is not empty
Due to a wrong substitution doc/examples is not added as a prerequisite
for the objects of the example programs. This results in compiler error
due to the non-existing output directory.

Bug-Id: 636

Signed-off-by: Janne Grunau <janne-libav@jannau.net>
2014-02-10 13:23:21 +01:00
Anton Khirnov
58f0d164de Makefile: add html template files to the doxygen deps 2014-01-01 13:07:57 +01:00
Andreas Unterweger
10421bcf0a Add an audio transcoding example.
Signed-off-by: Anton Khirnov <anton@khirnov.net>
2013-11-27 09:20:05 +01:00
Diego Biurrun
92f0abb27f build: Check for pod2man instead of perl for manual page generation
Some systems provide Perl without pod2man.
2013-11-26 13:49:06 -08:00
Diego Biurrun
ab81f24ad4 build: Integrate multilibrary examples into the build system
This includes moving libavformat/output-example to doc/examples/output.
2013-11-25 11:57:29 -08:00
Diego Biurrun
14abeaa43d build: Separate building programs linking against libav* from building av*
This will allow cleaner integration of building example programs.
2013-11-25 11:57:29 -08:00
Martin Storsjö
09cd0a3176 doc: Add the host executable suffix for the print_options dependency
This fixes building on windows.

Signed-off-by: Martin Storsjö <martin@martin.st>
2013-11-25 11:20:55 +02:00
Diego Biurrun
f187557ab4 build: more fine-grained dependencies for documentation build tools
Perl is needed to build the manual pages, texi2html for the HTML pages.
2013-11-23 09:45:06 -08:00
Vittorio Giovara
f4ca970dba configure: Add docdir configuration option
Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
2013-08-31 16:16:38 +02:00
Luca Barbato
7a95afe433 doc: fix dependencies in pod generation
The script can and will change.
2013-01-24 10:43:15 +01:00
Janne Grunau
b3fab1f2cd doc: add apidoc target for doxygen API documentation
Documentation includes only the externally visible API of the installed
headers.

Based on a patch by Anton Khirnov <anton@khirnov.net>.

Signed-off-by: Anton Khirnov <anton@khirnov.net>
2012-11-02 18:28:56 +01:00
Luca Barbato
175d0d94da doc: initial nut documentation 2012-10-08 11:22:42 +02:00
Mans Rullgard
b9d3c37848 build: use COMPILE template for HOSTOBJS
Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-07-26 23:58:59 +01:00
Mans Rullgard
2efb710a34 build: fix doc generation errors in parallel builds
The $(dir) function used to construct OBJDIRS includes a trailing slash
in the names returned, which GNU make 3.82 does not match to the
slash-less 'doc' in the documentation dependencies, causing parallel
build to fail.  Adding a slash fixes this and still works with make
3.81.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-28 11:42:19 +01:00
Diego Biurrun
8e0b7e2f14 build: Do not explicitly add the doc directory to the OBJDIRS list.
Now that a documentation generator is built in the doc directory,
this is no longer necessary.  Fixes the Make warning:
Makefile:188: target `doc' given more than once in the same rule.
2012-03-27 11:15:47 +02:00
Mans Rullgard
2ac3df858c doc: pass -Idoc texi2html and texi2pod
This fixes doc generation in build tree separate from source.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-20 11:10:25 +00:00
Anton Khirnov
0d0b81f941 Generate manpages for AV{Format,Codec}Context AVOptions. 2012-03-20 07:10:06 +01:00
Luca Barbato
1de6e14efe doc: split platform specific information
Move the platform-specific information in its own file.
2011-12-09 18:26:31 +01:00
Luca Barbato
2f017d9791 doc: port the git-howto to texinfo 2011-12-09 18:26:31 +01:00
Luca Barbato
1ebbdda1d2 doc: document fate in a texinfo
Summarize the information provided in the wiki and the one provided
in fate.txt
2011-12-09 18:26:17 +01:00
Diego Biurrun
47b20a1db0 build: merge lists of HTML documentation targets 2011-12-08 01:01:00 +01:00
Mans Rullgard
5e27ec28f0 build: create output directories as needed
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-29 09:14:56 +01:00
Mans Rullgard
7ac6910dd8 build: call texi2pod.pl with full path instead of symlink
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-28 18:15:19 +01:00
Mans Rullgard
f038cf3c74 build: remove SRC_PATH_BARE variable
Setting SRC_PATH to "." when building in-tree removes the need
for a quoted version of the source path since out-of-tree builds
are not possible if the pathname contains spaces.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-23 12:17:25 +01:00
Mans Rullgard
f87b03b50d build: move documentation rules to doc/Makefile
Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-22 22:59:46 +01:00
Diego Biurrun
e9b19db82b Make documentation build nonrecursive: Merge it into the top-level Makefile.
Originally committed as revision 9042 to svn://svn.ffmpeg.org/ffmpeg/trunk
2007-05-17 08:39:50 +00:00
Måns Rullgård
997baf0141 allow spaces in source and build directory names
out of tree builds from a source dir with spaces is impossible
due to how make handles vpath

Originally committed as revision 6938 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-11-08 00:02:15 +00:00
Diego Biurrun
3263626feb Mark all phony targets as such.
Originally committed as revision 6538 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-10-03 17:42:17 +00:00
Diego Biurrun
041514a422 Revert last commit, VPATH is necessary for out-of-tree builds.
Originally committed as revision 6014 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-08-17 16:28:47 +00:00
Diego Biurrun
cf41e66736 Remove unnecessary include and variable declaration.
Originally committed as revision 6013 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-08-17 16:02:57 +00:00
Philipp Matthias Hahn
8b8e1c5580 Out-of-directory build patch by (Philipp Matthias Hahn <pmhahn titan.lahn de>)
preserve support for spaces in directories in case of in-tree builds by (James A. Morrison <ja2morri csclub.uwaterloo ca>)

Originally committed as revision 3855 to svn://svn.ffmpeg.org/ffmpeg/trunk
2005-01-21 22:16:05 +00:00
Fabrice Bellard
e99c4e1037 added ffplay documentation - added automatic man page generation for ffmpeg, ffserver and ffplay
Originally committed as revision 2136 to svn://svn.ffmpeg.org/ffmpeg/trunk
2003-08-24 11:16:29 +00:00
Fabrice Bellard
c09948b6dc autogeneration of html files
Originally committed as revision 1927 to svn://svn.ffmpeg.org/ffmpeg/trunk
2003-06-02 20:13:30 +00:00
Philip Gladstone
9d6f1d52c5 Moved hook documentation into the doc directory
Originally committed as revision 1292 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-30 17:12:23 +00:00
Fabrice Bellard
c70a211997 ffserver documentation update
Originally committed as revision 1234 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-19 19:47:50 +00:00
Fabrice Bellard
3b783b6b58 added faq.html
Originally committed as revision 1159 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-11-04 18:50:27 +00:00
Fabrice Bellard
9181577ccb new texinfo documentation - HTML version also included
Originally committed as revision 1085 to svn://svn.ffmpeg.org/ffmpeg/trunk
2002-10-27 22:00:34 +00:00