ffmpeg/doc/Makefile

   1 LIBRARIES-$(CONFIG_AVUTIL)     += libavutil
   2 LIBRARIES-$(CONFIG_SWSCALE)    += libswscale
   3 LIBRARIES-$(CONFIG_SWRESAMPLE) += libswresample
   4 LIBRARIES-$(CONFIG_AVCODEC)    += libavcodec
   5 LIBRARIES-$(CONFIG_AVFORMAT)   += libavformat
   6 LIBRARIES-$(CONFIG_AVDEVICE)   += libavdevice
   7 LIBRARIES-$(CONFIG_AVFILTER)   += libavfilter
   8
   9 COMPONENTS-$(CONFIG_AVUTIL)     += ffmpeg-utils
  10 COMPONENTS-$(CONFIG_SWSCALE)    += ffmpeg-scaler
  11 COMPONENTS-$(CONFIG_SWRESAMPLE) += ffmpeg-resampler
  12 COMPONENTS-$(CONFIG_AVCODEC)    += ffmpeg-codecs ffmpeg-bitstream-filters
  13 COMPONENTS-$(CONFIG_AVFORMAT)   += ffmpeg-formats ffmpeg-protocols
  14 COMPONENTS-$(CONFIG_AVDEVICE)   += ffmpeg-devices
  15 COMPONENTS-$(CONFIG_AVFILTER)   += ffmpeg-filters
  16
  17 MANPAGES1   = $(AVPROGS-yes:%=doc/%.1)    $(AVPROGS-yes:%=doc/%-all.1)    $(COMPONENTS-yes:%=doc/%.1)
  18 MANPAGES3   = $(LIBRARIES-yes:%=doc/%.3)
  19 MANPAGES    = $(MANPAGES1) $(MANPAGES3)
  20 PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)  $(AVPROGS-yes:%=doc/%-all.pod)  $(COMPONENTS-yes:%=doc/%.pod)  $(LIBRARIES-yes:%=doc/%.pod)
  21 HTMLPAGES   = $(AVPROGS-yes:%=doc/%.html) $(AVPROGS-yes:%=doc/%-all.html) $(COMPONENTS-yes:%=doc/%.html) $(LIBRARIES-yes:%=doc/%.html) \
  22               doc/developer.html                                        \
  23               doc/faq.html                                              \
  24               doc/fate.html                                             \
  25               doc/general.html                                          \
  26               doc/git-howto.html                                        \
  27               doc/nut.html                                              \
  28               doc/platform.html                                         \
  29
  30 TXTPAGES    = doc/fate.txt                                              \
  31
  32
  33 DOCS-$(CONFIG_HTMLPAGES) += $(HTMLPAGES)
  34 DOCS-$(CONFIG_PODPAGES)  += $(PODPAGES)
  35 DOCS-$(CONFIG_MANPAGES)  += $(MANPAGES)
  36 DOCS-$(CONFIG_TXTPAGES)  += $(TXTPAGES)
  37 DOCS = $(DOCS-yes)
  38
  39 DOC_EXAMPLES-$(CONFIG_AVIO_READING_EXAMPLE)      += avio_reading
  40 DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE)           += avcodec
  41 DOC_EXAMPLES-$(CONFIG_DECODING_ENCODING_EXAMPLE) += decoding_encoding
  42 DOC_EXAMPLES-$(CONFIG_DEMUXING_DECODING_EXAMPLE) += demuxing_decoding
  43 DOC_EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
  44 DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
  45 DOC_EXAMPLES-$(CONFIG_FILTERING_AUDIO_EXAMPLE)   += filtering_audio
  46 DOC_EXAMPLES-$(CONFIG_FILTERING_VIDEO_EXAMPLE)   += filtering_video
  47 DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
  48 DOC_EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
  49 DOC_EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
  50 DOC_EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
  51 DOC_EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
  52 DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
  53 DOC_EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
  54 ALL_DOC_EXAMPLES_LIST = $(DOC_EXAMPLES-) $(DOC_EXAMPLES-yes)
  55
  56 DOC_EXAMPLES       := $(DOC_EXAMPLES-yes:%=doc/examples/%$(PROGSSUF)$(EXESUF))
  57 ALL_DOC_EXAMPLES   := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)$(EXESUF))
  58 ALL_DOC_EXAMPLES_G := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)_g$(EXESUF))
  59 PROGS              += $(DOC_EXAMPLES)
  60
  61 all-$(CONFIG_DOC): doc
  62
  63 doc: documentation
  64
  65 apidoc: doc/doxy/html
  66 documentation: $(DOCS)
  67
  68 examples: $(DOC_EXAMPLES)
  69
  70 TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $(SRC_PATH) $< $@ >$(@:%=%.d)
  71
  72 doc/%.txt: TAG = TXT
  73 doc/%.txt: doc/%.texi
  74         $(Q)$(TEXIDEP)
  75         $(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
  76
  77 GENTEXI  = format codec
  78 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
  79
  80 $(GENTEXI): TAG = GENTEXI
  81 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
  82         $(M)doc/print_options $* > $@
  83
  84 doc/%.html: TAG = HTML
  85 doc/%-all.html: TAG = HTML
  86
  87 ifdef HAVE_MAKEINFO_HTML
  88 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
  89         $(Q)$(TEXIDEP)
  90         $(M)makeinfo --html -I doc --no-split -D config-not-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
  91
  92 doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
  93         $(Q)$(TEXIDEP)
  94         $(M)makeinfo --html -I doc --no-split -D config-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
  95 else
  96 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
  97         $(Q)$(TEXIDEP)
  98         $(M)texi2html -I doc -monolithic --D=config-not-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
  99
 100 doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
 101         $(Q)$(TEXIDEP)
 102         $(M)texi2html -I doc -monolithic --D=config-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
 103 endif
 104
 105 doc/%.pod: TAG = POD
 106 doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
 107         $(Q)$(TEXIDEP)
 108         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-not-all=yes -Idoc $< $@
 109
 110 doc/%-all.pod: TAG = POD
 111 doc/%-all.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
 112         $(Q)$(TEXIDEP)
 113         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-all=yes -Idoc $< $@
 114
 115 doc/%.1 doc/%.3: TAG = MAN
 116 doc/%.1: doc/%.pod $(GENTEXI)
 117         $(M)pod2man --section=1 --center=" " --release=" " $< > $@
 118 doc/%.3: doc/%.pod $(GENTEXI)
 119         $(M)pod2man --section=3 --center=" " --release=" " $< > $@
 120
 121 $(DOCS) doc/doxy/html: | doc/
 122 $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
 123 OBJDIRS += doc/examples
 124
 125 DOXY_INPUT      = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
 126
 127 doc/doxy/html: TAG = DOXY
 128 doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(SRC_PATH)/doc/doxy-wrapper.sh $(DOXY_INPUT)
 129         $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXYGEN) $(DOXY_INPUT)
 130
 131 install-doc: install-html install-man
 132
 133 install-html:
 134
 135 install-man:
 136
 137 ifdef CONFIG_HTMLPAGES
 138 install-progs-$(CONFIG_DOC): install-html
 139
 140 install-html: $(HTMLPAGES)
 141         $(Q)mkdir -p "$(DOCDIR)"
 142         $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
 143 endif
 144
 145 ifdef CONFIG_MANPAGES
 146 install-progs-$(CONFIG_DOC): install-man
 147
 148 install-man: $(MANPAGES)
 149         $(Q)mkdir -p "$(MANDIR)/man1"
 150         $(INSTALL) -m 644 $(MANPAGES1) "$(MANDIR)/man1"
 151         $(Q)mkdir -p "$(MANDIR)/man3"
 152         $(INSTALL) -m 644 $(MANPAGES3) "$(MANDIR)/man3"
 153 endif
 154
 155 uninstall: uninstall-doc
 156
 157 uninstall-doc: uninstall-html uninstall-man
 158
 159 uninstall-html:
 160         $(RM) -r "$(DOCDIR)"
 161
 162 uninstall-man:
 163         $(RM) $(addprefix "$(MANDIR)/man1/",$(AVPROGS-yes:%=%.1) $(AVPROGS-yes:%=%-all.1) $(COMPONENTS-yes:%=%.1))
 164         $(RM) $(addprefix "$(MANDIR)/man3/",$(LIBRARIES-yes:%=%.3))
 165
 166 clean:: docclean
 167
 168 distclean:: docclean
 169         $(RM) doc/config.texi
 170
 171 examplesclean:
 172         $(RM) $(ALL_DOC_EXAMPLES) $(ALL_DOC_EXAMPLES_G)
 173         $(RM) $(CLEANSUFFIXES:%=doc/examples/%)
 174
 175 docclean: examplesclean
 176         $(RM) $(CLEANSUFFIXES:%=doc/%)
 177         $(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 doc/avoptions_*.texi
 178         $(RM) -r doc/doxy/html
 179
 180 -include $(wildcard $(DOCS:%=%.d))
 181
 182 .PHONY: apidoc doc documentation