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-yes = $(PROGS-yes)
  10 COMPONENTS-$(CONFIG_AVUTIL)     += ffmpeg-utils
  11 COMPONENTS-$(CONFIG_SWSCALE)    += ffmpeg-scaler
  12 COMPONENTS-$(CONFIG_SWRESAMPLE) += ffmpeg-resampler
  13 COMPONENTS-$(CONFIG_AVCODEC)    += ffmpeg-codecs ffmpeg-bitstream-filters
  14 COMPONENTS-$(CONFIG_AVFORMAT)   += ffmpeg-formats ffmpeg-protocols
  15 COMPONENTS-$(CONFIG_AVDEVICE)   += ffmpeg-devices
  16 COMPONENTS-$(CONFIG_AVFILTER)   += ffmpeg-filters
  17
  18 MANPAGES    = $(COMPONENTS-yes:%=doc/%.1)    $(LIBRARIES-yes:%=doc/%.3)
  19 PODPAGES    = $(COMPONENTS-yes:%=doc/%.pod)  $(LIBRARIES-yes:%=doc/%.pod)
  20 HTMLPAGES   = $(COMPONENTS-yes:%=doc/%.html) $(LIBRARIES-yes:%=doc/%.html)     \
  21               doc/developer.html                                        \
  22               doc/faq.html                                              \
  23               doc/fate.html                                             \
  24               doc/general.html                                          \
  25               doc/git-howto.html                                        \
  26               doc/nut.html                                              \
  27               doc/platform.html                                         \
  28
  29 TXTPAGES    = doc/fate.txt                                              \
  30
  31
  32 DOCS-$(CONFIG_HTMLPAGES) += $(HTMLPAGES)
  33 DOCS-$(CONFIG_PODPAGES)  += $(PODPAGES)
  34 DOCS-$(CONFIG_MANPAGES)  += $(MANPAGES)
  35 DOCS-$(CONFIG_TXTPAGES)  += $(TXTPAGES)
  36 DOCS = $(DOCS-yes)
  37
  38 all-$(CONFIG_DOC): doc
  39
  40 doc: documentation
  41
  42 apidoc: doc/doxy/html
  43 documentation: $(DOCS)
  44
  45 TEXIDEP = awk '/^@(verbatim)?include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
  46
  47 doc/%.txt: TAG = TXT
  48 doc/%.txt: doc/%.texi
  49         $(Q)$(TEXIDEP)
  50         $(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
  51
  52 GENTEXI  = format codec
  53 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
  54
  55 $(GENTEXI): TAG = GENTEXI
  56 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
  57         $(M)doc/print_options $* > $@
  58
  59 doc/%.html: TAG = HTML
  60 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
  61         $(Q)$(TEXIDEP)
  62         $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
  63
  64 doc/%.pod: TAG = POD
  65 doc/%.pod: doc/%.texi $(GENTEXI)
  66         $(Q)$(TEXIDEP)
  67         $(M)perl $(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
  68
  69 doc/%.1 doc/%.3: TAG = MAN
  70 doc/%.1: doc/%.pod $(GENTEXI)
  71         $(M)pod2man --section=1 --center=" " --release=" " $< > $@
  72 doc/%.3: doc/%.pod $(GENTEXI)
  73         $(M)pod2man --section=3 --center=" " --release=" " $< > $@
  74
  75 $(DOCS) doc/doxy/html: | doc/
  76
  77 doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS)
  78         $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^
  79
  80 install-man:
  81
  82 ifdef CONFIG_MANPAGES
  83 install-progs-$(CONFIG_DOC): install-man
  84
  85 install-man: $(MANPAGES)
  86         $(Q)mkdir -p "$(MANDIR)/man1"
  87         $(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
  88 endif
  89
  90 uninstall: uninstall-man
  91
  92 uninstall-man:
  93         $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
  94
  95 docclean: clean
  96
  97 clean::
  98         $(RM) $(TXTPAGES) doc/*.html doc/*.pod doc/*.1 doc/*.3 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_*.texi
  99         $(RM) -r doc/doxy/html
 100
 101 -include $(wildcard $(DOCS:%=%.d))
 102
 103 .PHONY: apidoc doc documentation