Makefile 3.39 KB
Newer Older
1 2 3 4
ALLMANPAGES = $(AVBASENAMES:%=%.1)
MANPAGES    = $(AVPROGS-yes:%=doc/%.1)
PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)
HTMLPAGES   = $(AVPROGS-yes:%=doc/%.html)                               \
5 6
              doc/developer.html                                        \
              doc/faq.html                                              \
7
              doc/fate.html                                             \
8
              doc/general.html                                          \
9
              doc/git-howto.html                                        \
10
              doc/libavfilter.html                                      \
11
              doc/nut.html                                              \
12
              doc/platform.html                                         \
13

14
DOCS-$(CONFIG_POD2MAN)                          += $(MANPAGES) $(PODPAGES)
15 16
DOCS-$(CONFIG_TEXI2HTML)                        += $(HTMLPAGES)
DOCS = $(DOCS-yes)
17

18
DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE)          += avcodec
19
DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)     += filter_audio
20
DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)         += metadata
21
DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE)           += output
22
DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)    += transcode_aac
23
ALL_DOC_EXAMPLES = avcodec filter_audio metadata output transcode_aac
24 25 26 27 28

DOC_EXAMPLES     := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
PROGS            += $(DOC_EXAMPLES)

29
all: $(DOCS)
30

31
apidoc: doc/doxy/html
32 33
documentation: $(DOCS)

34 35
examples: $(DOC_EXAMPLES)

36 37
TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)

38 39 40 41
GENTEXI  = format codec
GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)

$(GENTEXI): TAG = GENTEXI
42
$(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
43 44
	$(M)doc/print_options $* > $@

45
doc/%.html: TAG = HTML
46
doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
47
	$(Q)$(TEXIDEP)
48
	$(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
49 50

doc/%.pod: TAG = POD
51
doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
52
	$(Q)$(TEXIDEP)
53
	$(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
54 55

doc/%.1: TAG = MAN
56
doc/%.1: doc/%.pod $(GENTEXI)
57 58
	$(M)pod2man --section=1 --center=" " --release=" " $< > $@

59
$(DOCS) doc/doxy/html: | doc/
60
$(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
61
OBJDIRS += doc/examples
62

63
DOXY_INPUT      = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
64 65 66
DOXY_TEMPLATES  = doxy_stylesheet.css footer.html header.html
DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))

67 68
doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
	$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
69

70
install-progs-$(CONFIG_POD2MAN): install-man
71
install-progs-$(CONFIG_TEXI2HTML): install-doc
72 73 74 75

install-doc: $(HTMLPAGES)
	$(Q)mkdir -p "$(DOCDIR)"
	$(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
76 77 78 79 80

install-man: $(MANPAGES)
	$(Q)mkdir -p "$(MANDIR)/man1"
	$(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"

81 82 83 84
uninstall: uninstall-doc uninstall-man

uninstall-doc:
	$(RM) -r "$(DOCDIR)"
85 86 87 88 89

uninstall-man:
	$(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))

clean::
90 91 92
	$(RM) $(ALL_DOC_EXAMPLES)
	$(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
	$(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
93
	$(RM) -r doc/doxy/html
94 95 96

-include $(wildcard $(DOCS:%=%.d))

97
.PHONY: apidoc documentation