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