RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
ffmpeg/doc/Makefile

99 lines
3.4 KiB
Makefile
Raw Normal View History

build: Separate building programs linking against libav* from building av* This will allow cleaner integration of building example programs.
2013-11-02 15:44:18 +00:00
ALLMANPAGES = $(AVBASENAMES:%=%.1)
MANPAGES = $(AVPROGS-yes:%=doc/%.1)
PODPAGES = $(AVPROGS-yes:%=doc/%.pod)
HTMLPAGES = $(AVPROGS-yes:%=doc/%.html) \
build: merge lists of HTML documentation targets
2011-12-07 20:49:53 +00:00
doc/developer.html \
doc/faq.html \
doc: document fate in a texinfo Summarize the information provided in the wiki and the one provided in fate.txt
2011-12-02 00:33:07 +00:00
doc/fate.html \
build: merge lists of HTML documentation targets
2011-12-07 20:49:53 +00:00
doc/general.html \
doc: port the git-howto to texinfo
2011-12-03 17:06:14 +00:00
doc/git-howto.html \
build: merge lists of HTML documentation targets
2011-12-07 20:49:53 +00:00
doc/libavfilter.html \
doc: initial nut documentation
2011-12-13 22:50:20 +00:00
doc/nut.html \
doc: split platform specific information Move the platform-specific information in its own file.
2011-12-03 20:25:04 +00:00
doc/platform.html \
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
build: Check for pod2man instead of perl for manual page generation Some systems provide Perl without pod2man.
2013-11-26 19:37:54 +00:00
DOCS-$(CONFIG_POD2MAN) += $(MANPAGES) $(PODPAGES)
build: more fine-grained dependencies for documentation build tools Perl is needed to build the manual pages, texi2html for the HTML pages.
2013-11-22 00:57:56 +00:00
DOCS-$(CONFIG_TEXI2HTML) += $(HTMLPAGES)
DOCS = $(DOCS-yes)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
Move all example programs to doc/examples Also drop support for building examples in library directories.
2014-02-15 14:50:29 +00:00
DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE) += avcodec
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-13 07:50:16 +00:00
DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE) += filter_audio
Move all example programs to doc/examples Also drop support for building examples in library directories.
2014-02-15 14:50:29 +00:00
DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE) += metadata
build: Integrate multilibrary examples into the build system This includes moving libavformat/output-example to doc/examples/output.
2013-11-02 16:05:28 +00:00
DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE) += output
Add a QSV decoding example.
2015-02-11 23:07:29 +00:00
DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE) += qsvdec
Add an audio transcoding example. Signed-off-by: Anton Khirnov <anton@khirnov.net>
2013-10-08 11:10:46 +00:00
DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE) += transcode_aac
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-13 07:50:16 +00:00
ALL_DOC_EXAMPLES = avcodec filter_audio metadata output transcode_aac
build: Integrate multilibrary examples into the build system This includes moving libavformat/output-example to doc/examples/output.
2013-11-02 16:05:28 +00:00
DOC_EXAMPLES := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
PROGS += $(DOC_EXAMPLES)
build: more fine-grained dependencies for documentation build tools Perl is needed to build the manual pages, texi2html for the HTML pages.
2013-11-22 00:57:56 +00:00
all: $(DOCS)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
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-10-29 15:26:59 +00:00
apidoc: doc/doxy/html
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
documentation: $(DOCS)
build: Integrate multilibrary examples into the build system This includes moving libavformat/output-example to doc/examples/output.
2013-11-02 16:05:28 +00:00
examples: $(DOC_EXAMPLES)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
Generate manpages for AV{Format,Codec}Context AVOptions.
2012-03-14 19:08:50 +00:00
GENTEXI = format codec
GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
$(GENTEXI): TAG = GENTEXI
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-24 21:11:59 +00:00
$(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
Generate manpages for AV{Format,Codec}Context AVOptions.
2012-03-14 19:08:50 +00:00
$(M)doc/print_options $* > $@
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
doc/%.html: TAG = HTML
Generate manpages for AV{Format,Codec}Context AVOptions.
2012-03-14 19:08:50 +00:00
doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
$(Q)$(TEXIDEP)
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 10:54:02 +00:00
$(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
doc/%.pod: TAG = POD
doc: fix dependencies in pod generation The script can and will change.
2013-01-23 09:08:57 +00:00
doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
$(Q)$(TEXIDEP)
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 10:54:02 +00:00
$(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
doc/%.1: TAG = MAN
Generate manpages for AV{Format,Codec}Context AVOptions.
2012-03-14 19:08:50 +00:00
doc/%.1: doc/%.pod $(GENTEXI)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
$(M)pod2man --section=1 --center=" " --release=" " $< > $@
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-10-29 15:26:59 +00:00
$(DOCS) doc/doxy/html: | doc/
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-09 23:23:28 +00:00
$(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
build: Integrate multilibrary examples into the build system This includes moving libavformat/output-example to doc/examples/output.
2013-11-02 16:05:28 +00:00
OBJDIRS += doc/examples
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-10-29 15:26:59 +00:00
build: doxy: Include code examples in Doxygen documentation
2014-02-11 17:38:03 +00:00
DOXY_INPUT = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
Makefile: add html template files to the doxygen deps
2013-12-16 08:30:17 +00:00
DOXY_TEMPLATES = doxy_stylesheet.css footer.html header.html
DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))
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-11 16:30:43 +00:00
doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
build: create output directories as needed Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-28 17:45:13 +00:00
build: Check for pod2man instead of perl for manual page generation Some systems provide Perl without pod2man.
2013-11-26 19:37:54 +00:00
install-progs-$(CONFIG_POD2MAN): install-man
build: more fine-grained dependencies for documentation build tools Perl is needed to build the manual pages, texi2html for the HTML pages.
2013-11-22 00:57:56 +00:00
install-progs-$(CONFIG_TEXI2HTML): install-doc
configure: Add docdir configuration option Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
2013-08-28 08:30:14 +00:00
install-doc: $(HTMLPAGES)
$(Q)mkdir -p "$(DOCDIR)"
$(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
install-man: $(MANPAGES)
$(Q)mkdir -p "$(MANDIR)/man1"
$(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
configure: Add docdir configuration option Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
2013-08-28 08:30:14 +00:00
uninstall: uninstall-doc uninstall-man
uninstall-doc:
$(RM) -r "$(DOCDIR)"
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
uninstall-man:
$(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
clean::
build: Integrate multilibrary examples into the build system This includes moving libavformat/output-example to doc/examples/output.
2013-11-02 16:05:28 +00:00
$(RM) $(ALL_DOC_EXAMPLES)
$(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
$(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
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-10-29 15:26:59 +00:00
$(RM) -r doc/doxy/html
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
-include $(wildcard $(DOCS:%=%.d))
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-10-29 15:26:59 +00:00
.PHONY: apidoc documentation