git.sesse.net Git - ffmpeg/blob - 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_DIR_CMD_EXAMPLE)      += avio_dir_cmd
  40 DOC_EXAMPLES-$(CONFIG_AVIO_READING_EXAMPLE)      += avio_reading
  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_HTTP_MULTICLIENT_EXAMPLE)  += http_multiclient
  48 DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
  49 DOC_EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
  50 DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)            += qsvdec
  51 DOC_EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
  52 DOC_EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
  53 DOC_EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
  54 DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
  55 DOC_EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
  56 ALL_DOC_EXAMPLES_LIST = $(DOC_EXAMPLES-) $(DOC_EXAMPLES-yes)
  57
  58 DOC_EXAMPLES       := $(DOC_EXAMPLES-yes:%=doc/examples/%$(PROGSSUF)$(EXESUF))
  59 ALL_DOC_EXAMPLES   := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)$(EXESUF))
  60 ALL_DOC_EXAMPLES_G := $(ALL_DOC_EXAMPLES_LIST:%=doc/examples/%$(PROGSSUF)_g$(EXESUF))
  61 PROGS              += $(DOC_EXAMPLES)
  62
  63 all-$(CONFIG_DOC): doc
  64
  65 doc: documentation
  66
  67 apidoc: doc/doxy/html
  68 documentation: $(DOCS)
  69
  70 examples: $(DOC_EXAMPLES)
  71
  72 TEXIDEP = perl $(SRC_PATH)/doc/texidep.pl $(SRC_PATH) $< $@ >$(@:%=%.d)
  73
  74 doc/%.txt: TAG = TXT
  75 doc/%.txt: doc/%.texi
  76         $(Q)$(TEXIDEP)
  77         $(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
  78
  79 GENTEXI  = format codec
  80 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
  81
  82 $(GENTEXI): TAG = GENTEXI
  83 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
  84         $(M)doc/print_options $* > $@
  85
  86 doc/%.html: TAG = HTML
  87 doc/%-all.html: TAG = HTML
  88
  89 ifdef HAVE_MAKEINFO_HTML
  90 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
  91         $(Q)$(TEXIDEP)
  92         $(M)makeinfo --html -I doc --no-split -D config-not-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
  93
  94 doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.pm $(GENTEXI)
  95         $(Q)$(TEXIDEP)
  96         $(M)makeinfo --html -I doc --no-split -D config-all --init-file=$(SRC_PATH)/doc/t2h.pm --output $@ $<
  97 else
  98 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
  99         $(Q)$(TEXIDEP)
 100         $(M)texi2html -I doc -monolithic --D=config-not-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
 101
 102 doc/%-all.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
 103         $(Q)$(TEXIDEP)
 104         $(M)texi2html -I doc -monolithic --D=config-all --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
 105 endif
 106
 107 doc/%.pod: TAG = POD
 108 doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
 109         $(Q)$(TEXIDEP)
 110         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-not-all=yes -Idoc $< $@
 111
 112 doc/%-all.pod: TAG = POD
 113 doc/%-all.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
 114         $(Q)$(TEXIDEP)
 115         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Dconfig-all=yes -Idoc $< $@
 116
 117 doc/%.1 doc/%.3: TAG = MAN
 118 doc/%.1: doc/%.pod $(GENTEXI)
 119         $(M)pod2man --section=1 --center=" " --release=" " --date=" " $< > $@
 120 doc/%.3: doc/%.pod $(GENTEXI)
 121         $(M)pod2man --section=3 --center=" " --release=" " --date=" " $< > $@
 122
 123 $(DOCS) doc/doxy/html: | doc/
 124 $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
 125 OBJDIRS += doc/examples
 126
 127 DOXY_INPUT      = $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c)
 128 DOXY_INPUT_DEPS = $(addprefix $(SRC_PATH)/, $(DOXY_INPUT)) config.mak
 129
 130 doc/doxy/html: TAG = DOXY
 131 doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(SRC_PATH)/doc/doxy-wrapper.sh $(DOXY_INPUT_DEPS)
 132         $(M)OUT_DIR=$$PWD/doc/doxy; cd $(SRC_PATH); ./doc/doxy-wrapper.sh $$OUT_DIR $< $(DOXYGEN) $(DOXY_INPUT);
 133
 134 install-doc: install-html install-man
 135
 136 install-html:
 137
 138 install-man:
 139
 140 ifdef CONFIG_HTMLPAGES
 141 install-progs-$(CONFIG_DOC): install-html
 142
 143 install-html: $(HTMLPAGES)
 144         $(Q)mkdir -p "$(DOCDIR)"
 145         $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
 146 endif
 147
 148 ifdef CONFIG_MANPAGES
 149 install-progs-$(CONFIG_DOC): install-man
 150
 151 install-man: $(MANPAGES)
 152         $(Q)mkdir -p "$(MANDIR)/man1"
 153         $(INSTALL) -m 644 $(MANPAGES1) "$(MANDIR)/man1"
 154         $(Q)mkdir -p "$(MANDIR)/man3"
 155         $(INSTALL) -m 644 $(MANPAGES3) "$(MANDIR)/man3"
 156 endif
 157
 158 uninstall: uninstall-doc
 159
 160 uninstall-doc: uninstall-html uninstall-man
 161
 162 uninstall-html:
 163         $(RM) -r "$(DOCDIR)"
 164
 165 uninstall-man:
 166         $(RM) $(addprefix "$(MANDIR)/man1/",$(AVPROGS-yes:%=%.1) $(AVPROGS-yes:%=%-all.1) $(COMPONENTS-yes:%=%.1))
 167         $(RM) $(addprefix "$(MANDIR)/man3/",$(LIBRARIES-yes:%=%.3))
 168
 169 clean:: docclean
 170
 171 distclean:: docclean
 172         $(RM) doc/config.texi
 173
 174 examplesclean:
 175         $(RM) $(ALL_DOC_EXAMPLES) $(ALL_DOC_EXAMPLES_G)
 176         $(RM) $(CLEANSUFFIXES:%=doc/examples/%)
 177
 178 docclean: examplesclean
 179         $(RM) $(CLEANSUFFIXES:%=doc/%)
 180         $(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 doc/avoptions_*.texi
 181         $(RM) -r doc/doxy/html
 182
 183 -include $(wildcard $(DOCS:%=%.d))
 184
 185 .PHONY: apidoc doc documentation