mirrors/librempeg
1
0
Fork 0
mirror of https://github.com/librempeg/librempeg synced 2024-11-23 03:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
989c6a4943
librempeg/doc/Makefile

96 lines
3.1 KiB
Makefile
Raw Normal View History

doc: add libavutil.texi With some fixes and better wording by Alexander Strasser <eclipse7@gmx.net>.
2012-11-04 11:42:47 +00:00
DOCLIBS-$(CONFIG_AVUTIL) += libavutil
doc: add libswscale.texi and ffmpeg-scaler.texi files
2012-11-13 22:49:09 +00:00
DOCLIBS-$(CONFIG_SWSCALE) += libswscale
doc: add libswresample.texi and ffmpeg-resampler.texi files
2012-11-02 11:24:04 +00:00
DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
doc/Makefile: change DOCLIBS check More consistent with the rest of the build system, and more compact.
2012-11-07 22:11:02 +00:00
DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
doc: add libavformat.texi and ffmpeg-formats.texi files
2012-11-18 12:39:18 +00:00
DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
doc: add libavdevice.texi and ffmpeg-devices.texi files
2012-11-26 22:38:32 +00:00
DOCLIBS-$(CONFIG_AVDEVICE) += libavdevice
doc: add libavfilter.texi With some re-wording by Alexander Strasser <eclipse7@gmx.net>.
2012-11-04 11:12:56 +00:00
DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
doc: add libavcodec.texi The option chapter is based on the avoptions_codec.texi auto-generated file.
2012-11-01 12:20:44 +00:00
doc: add ffmpeg-bitstream-filters.texi file
2012-11-26 22:58:40 +00:00
COMPONENTS=$(PROGS-yes) ffmpeg-bitstream-filters ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
doc: move codec options and descriptions to a dedicated manual page
2012-11-18 12:00:11 +00:00
MANPAGES = $(COMPONENTS:%=doc/%.1) $(DOCLIBS-yes:%=doc/%.3)
PODPAGES = $(COMPONENTS:%=doc/%.pod) $(DOCLIBS-yes:%=doc/%.pod)
HTMLPAGES = $(COMPONENTS:%=doc/%.html) $(DOCLIBS-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 \
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 \
doc: add syntax.texi file
2012-05-03 13:14:14 +00:00
doc/syntax.html \
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
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>
2011-12-19 23:28:47 +00:00
TXTPAGES = doc/fate.txt \
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.
2012-08-09 21:37:28 +00:00
DOCS-$(CONFIG_HTMLPAGES) += $(HTMLPAGES)
DOCS-$(CONFIG_PODPAGES) += $(PODPAGES)
DOCS-$(CONFIG_MANPAGES) += $(MANPAGES)
DOCS-$(CONFIG_TXTPAGES) += $(TXTPAGES)
build: Fix documentation dependencies and rules
2012-07-12 01:41:25 +00:00
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
doc/Makefile: add doc target, as an alias for "documentation" Consistent with --enable-doc, and easier to type.
2012-08-11 09:58:57 +00:00
all-$(CONFIG_DOC): doc
doc: documentation
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)
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>
2011-12-19 23:27:22 +00:00
TEXIDEP = awk '/^@(verbatim)?include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
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>
2011-12-19 23:28:47 +00:00
doc/%.txt: TAG = TXT
doc/%.txt: doc/%.texi
$(Q)$(TEXIDEP)
$(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
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/Makefile: Add missing $(HOSTEXESUF) to print_options
2012-07-12 01:45:00 +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
Generate manpages for AV{Format,Codec}Context AVOptions.
2012-03-14 19:08:50 +00:00
doc/%.pod: doc/%.texi $(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/Makefile: invoke perl to interpret texi2pod.pl Do not rely on shebang directive in the script, whose exact behavior is system dependent.
2012-08-10 09:49:27 +00:00
$(M)perl $(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: add libavcodec.texi The option chapter is based on the avoptions_codec.texi auto-generated file.
2012-11-01 12:20:44 +00:00
doc/%.1 doc/%.3: TAG = MAN
doc/Makefile: generate library headers with the correct section number
2012-11-11 11:50:44 +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/Makefile: generate library headers with the correct section number
2012-11-11 11:50:44 +00:00
doc/%.3: doc/%.pod $(GENTEXI)
$(M)pod2man --section=3 --center=" " --release=" " $< > $@
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
$(DOCS) doc/doxy/html: | doc/
doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS)
$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^
build: create output directories as needed Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-28 17:45:13 +00:00
build: Fix documentation dependencies and rules
2012-07-12 01:41:25 +00:00
install-man:
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.
2012-08-09 21:37:28 +00:00
ifdef CONFIG_MANPAGES
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
install-progs-$(CONFIG_DOC): install-man
install-man: $(MANPAGES)
$(Q)mkdir -p "$(MANDIR)/man1"
$(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
build: Fix documentation dependencies and rules
2012-07-12 01:41:25 +00:00
endif
build: move documentation rules to doc/Makefile Signed-off-by: Mans Rullgard <mans@mansr.com>
2011-06-06 17:03:22 +00:00
uninstall: uninstall-man
uninstall-man:
$(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
clean::
doc/Makefile: remove .3 file with make clean
2012-11-06 11:23:13 +00:00
$(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 $(CLEANSUFFIXES:%=doc/%) 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))
Merge remote-tracking branch 'qatar/master' * qatar/master: doc: add apidoc target for doxygen API documentation matroskadec: do not use avpacket internals Conflicts: doc/Makefile libavformat/matroskadec.c Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-11-03 13:47:50 +00:00
.PHONY: apidoc doc documentation
Reference in New Issue Copy Permalink