projects / ffmpeg.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge commit '533339bdcc3b39bbd708c723b3cd0b5898350f0f'
[ffmpeg.git] / doc / Makefile
diff --git a/doc/Makefile b/doc/Makefile
index bd5c2e4..b83f2d5 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,110 +1,189 @@
-ALLMANPAGES = $(AVBASENAMES:%=%.1)
-MANPAGES    = $(AVPROGS-yes:%=doc/%.1)
-PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)
-PROGSHTML   = $(AVPROGS-yes:%=doc/%.html)
-HTMLPAGES   = $(PROGSHTML)                                              \
+LIBRARIES-$(CONFIG_AVUTIL)     += libavutil
+LIBRARIES-$(CONFIG_SWSCALE)    += libswscale
+LIBRARIES-$(CONFIG_SWRESAMPLE) += libswresample
+LIBRARIES-$(CONFIG_AVCODEC)    += libavcodec
+LIBRARIES-$(CONFIG_AVFORMAT)   += libavformat
+LIBRARIES-$(CONFIG_AVDEVICE)   += libavdevice
+LIBRARIES-$(CONFIG_AVFILTER)   += libavfilter
+
+COMPONENTS-$(CONFIG_AVUTIL)     += ffmpeg-utils
+COMPONENTS-$(CONFIG_SWSCALE)    += ffmpeg-scaler
+COMPONENTS-$(CONFIG_SWRESAMPLE) += ffmpeg-resampler
+COMPONENTS-$(CONFIG_AVCODEC)    += ffmpeg-codecs ffmpeg-bitstream-filters
+COMPONENTS-$(CONFIG_AVFORMAT)   += ffmpeg-formats ffmpeg-protocols
+COMPONENTS-$(CONFIG_AVDEVICE)   += ffmpeg-devices
+COMPONENTS-$(CONFIG_AVFILTER)   += ffmpeg-filters
+
+MANPAGES1   = $(AVPROGS-yes:%=doc/%.1)    $(AVPROGS-yes:%=doc/%-all.1)    $(COMPONENTS-yes:%=doc/%.1)
+MANPAGES3   = $(LIBRARIES-yes:%=doc/%.3)
+MANPAGES    = $(MANPAGES1) $(MANPAGES3)
+PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)  $(AVPROGS-yes:%=doc/%-all.pod)  $(COMPONENTS-yes:%=doc/%.pod)  $(LIBRARIES-yes:%=doc/%.pod)
+HTMLPAGES   = $(AVPROGS-yes:%=doc/%.html) $(AVPROGS-yes:%=doc/%-all.html) $(COMPONENTS-yes:%=doc/%.html) $(LIBRARIES-yes:%=doc/%.html) \
               doc/developer.html                                        \
               doc/faq.html                                              \
               doc/fate.html                                             \
               doc/general.html                                          \
               doc/git-howto.html                                        \
               doc/developer.html                                        \
               doc/faq.html                                              \
               doc/fate.html                                             \
               doc/general.html                                          \
               doc/git-howto.html                                        \
-              doc/libavfilter.html                                      \
               doc/nut.html                                              \
               doc/platform.html                                         \
 
               doc/nut.html                                              \
               doc/platform.html                                         \
 
-DOCS-$(CONFIG_POD2MAN)                          += $(MANPAGES) $(PODPAGES)
-DOCS-$(CONFIG_TEXI2HTML)                        += $(HTMLPAGES)
+TXTPAGES    = doc/fate.txt                                              \
+
+
+DOCS-$(CONFIG_HTMLPAGES) += $(HTMLPAGES)
+DOCS-$(CONFIG_PODPAGES)  += $(PODPAGES)
+DOCS-$(CONFIG_MANPAGES)  += $(MANPAGES)
+DOCS-$(CONFIG_TXTPAGES)  += $(TXTPAGES)
 DOCS = $(DOCS-yes)
 
 DOCS = $(DOCS-yes)
 
-DOC_EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)     += decode_audio
-DOC_EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)     += decode_video
-DOC_EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)     += encode_audio
-DOC_EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)     += encode_video
-DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)     += filter_audio
-DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)         += metadata
-DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE)           += output
-DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)           += qsvdec
-DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)    += transcode_aac
-ALL_DOC_EXAMPLES = decode_audio                                         \
-                   decode_video                                         \
-                   encode_audio                                         \
-                   encode_video                                         \
-                   filter_audio                                         \
-                   metadata output                                      \
-                   transcode_aac                                        \
-
-DOC_EXAMPLES     := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
-ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
-PROGS            += $(DOC_EXAMPLES)
-
-all: $(DOCS)
+DOC_EXAMPLES-$(CONFIG_AVIO_DIR_CMD_EXAMPLE)      += avio_dir_cmd
+DOC_EXAMPLES-$(CONFIG_AVIO_READING_EXAMPLE)      += avio_reading
+DOC_EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
+DOC_EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)      += decode_video
+DOC_EXAMPLES-$(CONFIG_DEMUXING_DECODING_EXAMPLE) += demuxing_decoding
+DOC_EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)      += encode_audio
+DOC_EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
+DOC_EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
+DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
+DOC_EXAMPLES-$(CONFIG_FILTERING_AUDIO_EXAMPLE)   += filtering_audio
+DOC_EXAMPLES-$(CONFIG_FILTERING_VIDEO_EXAMPLE)   += filtering_video
+DOC_EXAMPLES-$(CONFIG_HTTP_MULTICLIENT_EXAMPLE)  += http_multiclient
+DOC_EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
+DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
+DOC_EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
+DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)            += qsvdec
+DOC_EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
+DOC_EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
+DOC_EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
+DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
+DOC_EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
+ALL_DOC_EXAMPLES_LIST = $(DOC_EXAMPLES-) $(DOC_EXAMPLES-yes)
+
+DOC_EXAMPLES       := $(DOC_EXAMPLES-yes:%=doc/examples/%$(PROGSSUF)$(EXESUF))
+ALL_DOC_EXAMPLES   := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)$(EXESUF))
+ALL_DOC_EXAMPLES_G := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)_g$(EXESUF))
+PROGS              += $(DOC_EXAMPLES)
+
+all-$(CONFIG_DOC): doc
+
+doc: documentation
 
 apidoc: doc/doxy/html
 documentation: $(DOCS)
 
 examples: $(DOC_EXAMPLES)
 
 
 apidoc: doc/doxy/html
 documentation: $(DOCS)
 
 examples: $(DOC_EXAMPLES)
 
-TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
+TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $(SRC_PATH) $< $@ >$(@:%=%.d)
+
+doc/%.txt: TAG = TXT
+doc/%.txt: doc/%.texi
+       $(Q)$(TEXIDEP)
+       $(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
 
 GENTEXI  = format codec
 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
 
 
 GENTEXI  = format codec
 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
 
-$(MANPAGES) $(PODPAGES) $(PROGSHTML): $(GENTEXI)
-
 $(GENTEXI): TAG = GENTEXI
 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
        $(M)doc/print_options $* > $@
 
 doc/%.html: TAG = HTML
 $(GENTEXI): TAG = GENTEXI
 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
        $(M)doc/print_options $* > $@
 
 doc/%.html: TAG = HTML
-doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init
+doc/%-all.html: TAG = HTML
+
+ifdef HAVE_MAKEINFO_HTML
+doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
+       $(Q)$(TEXIDEP)
+       $(M)makeinfo --html -I doc --no-split -D config-not-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
+
+doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
+       $(Q)$(TEXIDEP)
+       $(M)makeinfo --html -I doc --no-split -D config-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
+else
+doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
+       $(Q)$(TEXIDEP)
+       $(M)texi2html -I doc -monolithic --D=config-not-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
+
+doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
        $(Q)$(TEXIDEP)
        $(Q)$(TEXIDEP)
-       $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
+       $(M)texi2html -I doc -monolithic --D=config-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
+endif
 
 doc/%.pod: TAG = POD
 
 doc/%.pod: TAG = POD
-doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl
+doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
        $(Q)$(TEXIDEP)
        $(Q)$(TEXIDEP)
-       $(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
+       $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-not-all=yes -Idoc $< $@
 
 
-doc/%.1: TAG = MAN
-doc/%.1: doc/%.pod
-       $(M)pod2man --section=1 --center=" " --release=" " $< > $@
+doc/%-all.pod: TAG = POD
+doc/%-all.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
+       $(Q)$(TEXIDEP)
+       $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-all=yes -Idoc $< $@
+
+doc/%.1 doc/%.3: TAG = MAN
+doc/%.1: doc/%.pod $(GENTEXI)
+       $(M)pod2man --section=1 --center=" " --release=" " --date=" " $< > $@
+doc/%.3: doc/%.pod $(GENTEXI)
+       $(M)pod2man --section=3 --center=" " --release=" " --date=" " $< > $@
 
 $(DOCS) doc/doxy/html: | doc/
 $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
 OBJDIRS += doc/examples
 
 
 $(DOCS) doc/doxy/html: | doc/
 $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
 OBJDIRS += doc/examples
 
-DOXY_INPUT      = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c))
-DOXY_TEMPLATES  = doxy_stylesheet.css footer.html header.html
-DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))
+DOXY_INPUT      = $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c)
+DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) ffbuild/config.mak
+
+doc/doxy/html: TAG = DOXY
+doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(SRC_PATH)/doc/doxy-wrapper.sh $(DOXY_INPUT_DEPS)
+       $(M)OUT_DIR=$$PWD/doc/doxy; cd $(SRC_PATH); ./doc/doxy-wrapper.sh $$OUT_DIR $< $(DOXYGEN) $(DOXY_INPUT);
+
+install-doc: install-html install-man
+
+install-html:
 
 
-doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
-       $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
+install-man:
 
 
-install-progs-$(CONFIG_POD2MAN): install-man
-install-progs-$(CONFIG_TEXI2HTML): install-doc
+ifdef CONFIG_HTMLPAGES
+install-progs-$(CONFIG_DOC): install-html
 
 
-install-doc: $(HTMLPAGES)
+install-html: $(HTMLPAGES)
        $(Q)mkdir -p "$(DOCDIR)"
        $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
        $(Q)mkdir -p "$(DOCDIR)"
        $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
+endif
+
+ifdef CONFIG_MANPAGES
+install-progs-$(CONFIG_DOC): install-man
 
 install-man: $(MANPAGES)
        $(Q)mkdir -p "$(MANDIR)/man1"
 
 install-man: $(MANPAGES)
        $(Q)mkdir -p "$(MANDIR)/man1"
-       $(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
+       $(INSTALL) -m 644 $(MANPAGES1) "$(MANDIR)/man1"
+       $(Q)mkdir -p "$(MANDIR)/man3"
+       $(INSTALL) -m 644 $(MANPAGES3) "$(MANDIR)/man3"
+endif
+
+uninstall: uninstall-doc
 
 
-uninstall: uninstall-doc uninstall-man
+uninstall-doc: uninstall-html uninstall-man
 
 
-uninstall-doc:
+uninstall-html:
        $(RM) -r "$(DOCDIR)"
 
 uninstall-man:
        $(RM) -r "$(DOCDIR)"
 
 uninstall-man:
-       $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
+       $(RM) $(addprefix "$(MANDIR)/man1/",$(AVPROGS-yes:%=%.1) $(AVPROGS-yes:%=%-all.1) $(COMPONENTS-yes:%=%.1))
+       $(RM) $(addprefix "$(MANDIR)/man3/",$(LIBRARIES-yes:%=%.3))
+
+clean:: docclean
+
+distclean:: docclean
+       $(RM) doc/config.texi
+
+examplesclean:
+       $(RM) $(ALL_DOC_EXAMPLES) $(ALL_DOC_EXAMPLES_G)
+       $(RM) $(CLEANSUFFIXES:%=doc/examples/%)
 
 
-clean::
-       $(RM) $(ALL_DOC_EXAMPLES)
-       $(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
-       $(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
+docclean: examplesclean
+       $(RM) $(CLEANSUFFIXES:%=doc/%)
+       $(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 doc/avoptions_*.texi
        $(RM) -r doc/doxy/html
 
 -include $(wildcard $(DOCS:%=%.d))
 
        $(RM) -r doc/doxy/html
 
 -include $(wildcard $(DOCS:%=%.d))
 
-.PHONY: apidoc documentation
+.PHONY: apidoc doc documentation
FFmpeg git repo