Stefano Sabatini
be3f4c13b6
doc/Makefile: install .3 man pages to man3 subdir
...
Fix trac ticket #2585 .
12 years ago
Stefano Sabatini
90cb081f88
build: drop unused ALLMANPAGES variable
12 years ago
Stefano Sabatini
9b4d9d8795
doc: enable compilation of -all tool pages
...
In particular, add documentation configuration system, through the
doc/config.texi file.
Fix trac issue #2374 .
12 years ago
Luca Barbato
7a95afe433
doc: fix dependencies in pod generation
...
The script can and will change.
12 years ago
James Almer
4f8b73129b
doc/Makefile: Fix make docclean
...
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Clément Bœsch
00ebac6dfd
doc: stop generating syntax.html.
...
Just like doc/eval.texi, this file is meant to be included from
ffmpeg-utils.texi, and not to be used as a standalone documentation.
12 years ago
Stefano Sabatini
9bba683578
doc/Makefile: add docclean rule
...
This allows to clean the doc directory from the parent project dir.
The command:
make -C doc clean
does not work as long as the paths specified in doc/Makefile are relative
to the parent dir.
Also it is consitent with "testclean" and "distclean" targets.
12 years ago
Stefano Sabatini
cf56c20761
doc/Makefile: rework component configuration logic
...
Only enable component manual when the corresponding library providing
the feature is enabled.
12 years ago
Stefano Sabatini
5ddc072d0d
doc: add ffmpeg-bitstream-filters.texi file
12 years ago
Stefano Sabatini
3a227f5d90
doc: add ffmpeg-protocols.texi manual
12 years ago
Stefano Sabatini
9c492271a8
doc: move syntax and eval chapters from libavutil to ffmpeg-utils
...
Move utilities description to a dedicated manual, consistent with what I
did with the rest of the documentation.
12 years ago
Stefano Sabatini
d82331721e
doc: add libavdevice.texi and ffmpeg-devices.texi files
12 years ago
Stefano Sabatini
8ddeae5ae7
doc: add libavformat.texi and ffmpeg-formats.texi files
12 years ago
Stefano Sabatini
cf6c6134cd
doc: add libswscale.texi and ffmpeg-scaler.texi files
12 years ago
Stefano Sabatini
e903cb4194
doc: add libswresample.texi and ffmpeg-resampler.texi files
12 years ago
Stefano Sabatini
f62abbf3b7
doc: move filters documentation to dedicated manual page ffmpeg-filters
12 years ago
Stefano Sabatini
fa4ead1d66
doc: move codec options and descriptions to a dedicated manual page
12 years ago
Stefano Sabatini
c0aff4064d
doc/Makefile: generate library headers with the correct section number
12 years ago
Stefano Sabatini
514910fb2d
doc: add libavfilter.texi
...
With some re-wording by Alexander Strasser <eclipse7@gmx.net>.
12 years ago
Stefano Sabatini
598546e1df
doc: add libavutil.texi
...
With some fixes and better wording by Alexander Strasser
<eclipse7@gmx.net>.
12 years ago
Stefano Sabatini
58d1d7024d
doc/Makefile: change DOCLIBS check
...
More consistent with the rest of the build system, and more compact.
12 years ago
Stefano Sabatini
a1934daeb4
doc/Makefile: remove .3 file with make clean
12 years ago
Stefano Sabatini
617d0d41a2
doc: add libavcodec.texi
...
The option chapter is based on the avoptions_codec.texi auto-generated
file.
12 years ago
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>
12 years ago
Luca Barbato
175d0d94da
doc: initial nut documentation
12 years ago
Stefano Sabatini
8e2cf68d09
doc/Makefile: add doc target, as an alias for "documentation"
...
Consistent with --enable-doc, and easier to type.
13 years ago
Stefano Sabatini
c3da2c19e4
build: extend documentation building mechanism
...
Allow to select specific documentation components, and reliably check for
component dependencies.
In particular, check for perl presence on the system.
13 years ago
Stefano Sabatini
e874b29296
doc/Makefile: invoke perl to interpret texi2pod.pl
...
Do not rely on shebang directive in the script, whose exact behavior is
system dependent.
13 years ago
Mans Rullgard
b9d3c37848
build: use COMPILE template for HOSTOBJS
...
Signed-off-by: Mans Rullgard <mans@mansr.com>
13 years ago
jamal
d48f014ff1
doc/Makefile: Add missing $(HOSTEXESUF) to print_options
13 years ago
jamal
3e03f8d8b2
build: Fix documentation dependencies and rules
13 years ago
Stefano Sabatini
5a6c7a218c
doc: merge libavfilter.texi into filters.texi
...
There is no much point into splitting documentation for filters. Also
having a separate document for a library is inconsistent.
13 years ago
Stefano Sabatini
27127ebe6c
doc: add syntax.texi file
13 years ago
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>
13 years ago
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.
13 years ago
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>
13 years ago
Anton Khirnov
0d0b81f941
Generate manpages for AV{Format,Codec}Context AVOptions.
13 years ago
Alexander Strasser
c7062802d9
doc: build: TEXIDEP: Recognize verbatim includes
...
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude ) should also be taken into account.
Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Michael Niedermayer
c2c284b3eb
Revert "doc: build: TEXIDEP: Recognize verbatim includes"
...
This reverts commit e5cbf24e45
.
This commits breaks out of tree builds
13 years ago
Alexander Strasser
abab44086f
doc: fate: Support building a plain text version
...
Also create a plain text (.txt) file from fate.texi if the makeinfo
program is available.
Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Alexander Strasser
e5cbf24e45
doc: build: TEXIDEP: Recognize verbatim includes
...
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude ) should also be taken into account.
Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Luca Barbato
1de6e14efe
doc: split platform specific information
...
Move the platform-specific information in its own file.
13 years ago
Luca Barbato
2f017d9791
doc: port the git-howto to texinfo
13 years ago
Luca Barbato
1ebbdda1d2
doc: document fate in a texinfo
...
Summarize the information provided in the wiki and the one provided
in fate.txt
13 years ago
Diego Biurrun
47b20a1db0
build: merge lists of HTML documentation targets
13 years ago
Mans Rullgard
5e27ec28f0
build: create output directories as needed
...
Signed-off-by: Mans Rullgard <mans@mansr.com>
14 years ago
Mans Rullgard
7ac6910dd8
build: call texi2pod.pl with full path instead of symlink
...
Signed-off-by: Mans Rullgard <mans@mansr.com>
14 years ago
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>
14 years ago
Mans Rullgard
f87b03b50d
build: move documentation rules to doc/Makefile
...
Signed-off-by: Mans Rullgard <mans@mansr.com>
14 years ago
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
18 years ago