Commit | Line | Data |
---|---|---|
ec8f24b7 | 1 | # SPDX-License-Identifier: GPL-2.0-only |
761a0f39 | 2 | include ../../scripts/Makefile.include |
ca70c24f | 3 | include ../../scripts/utilities.mak |
af3df2cf | 4 | |
c1c2365a IM |
5 | MAN1_TXT= \ |
6 | $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ | |
7 | $(wildcard perf-*.txt)) \ | |
8 | perf.txt | |
9 | MAN5_TXT= | |
10 | MAN7_TXT= | |
11 | ||
12 | MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT) | |
762b2935 FBH |
13 | _MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT)) |
14 | _MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT)) | |
c1c2365a | 15 | |
762b2935 FBH |
16 | MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML)) |
17 | MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML)) | |
c1c2365a IM |
18 | |
19 | ARTICLES = | |
20 | # with their own formatting rules. | |
21 | SP_ARTICLES = | |
22 | API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) | |
23 | SP_ARTICLES += $(API_DOCS) | |
24 | SP_ARTICLES += technical/api-index | |
25 | ||
762b2935 FBH |
26 | _DOC_HTML = $(_MAN_HTML) |
27 | _DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) | |
28 | DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML)) | |
c1c2365a | 29 | |
762b2935 FBH |
30 | _DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT)) |
31 | _DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT)) | |
32 | _DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT)) | |
33 | ||
34 | DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1)) | |
35 | DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5)) | |
36 | DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7)) | |
c1c2365a | 37 | |
7ae5f213 JK |
38 | # Make the path relative to DESTDIR, not prefix |
39 | ifndef DESTDIR | |
c1c2365a | 40 | prefix?=$(HOME) |
7ae5f213 | 41 | endif |
c1c2365a IM |
42 | bindir?=$(prefix)/bin |
43 | htmldir?=$(prefix)/share/doc/perf-doc | |
44 | pdfdir?=$(prefix)/share/doc/perf-doc | |
45 | mandir?=$(prefix)/share/man | |
46 | man1dir=$(mandir)/man1 | |
47 | man5dir=$(mandir)/man5 | |
48 | man7dir=$(mandir)/man7 | |
c1c2365a IM |
49 | |
50 | ASCIIDOC=asciidoc | |
ffef80ec TI |
51 | ASCIIDOC_EXTRA = --unsafe -f asciidoc.conf |
52 | ASCIIDOC_HTML = xhtml11 | |
c1c2365a IM |
53 | MANPAGE_XSL = manpage-normal.xsl |
54 | XMLTO_EXTRA = | |
55 | INSTALL?=install | |
56 | RM ?= rm -f | |
57 | DOC_REF = origin/man | |
58 | HTML_REF = origin/html | |
59 | ||
ffef80ec TI |
60 | ifdef USE_ASCIIDOCTOR |
61 | ASCIIDOC = asciidoctor | |
62 | ASCIIDOC_EXTRA = -a compat-mode | |
63 | ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions | |
64 | ASCIIDOC_EXTRA += -a mansource="perf" -a manmanual="perf Manual" | |
65 | ASCIIDOC_HTML = xhtml5 | |
66 | endif | |
67 | ||
c1c2365a IM |
68 | infodir?=$(prefix)/share/info |
69 | MAKEINFO=makeinfo | |
70 | INSTALL_INFO=install-info | |
71 | DOCBOOK2X_TEXI=docbook2x-texi | |
72 | DBLATEX=dblatex | |
af3df2cf | 73 | XMLTO=xmlto |
c1c2365a IM |
74 | ifndef PERL_PATH |
75 | PERL_PATH = /usr/bin/perl | |
76 | endif | |
77 | ||
78 | -include ../config.mak.autogen | |
79 | -include ../config.mak | |
80 | ||
af3df2cf BP |
81 | _tmp_tool_path := $(call get-executable,$(ASCIIDOC)) |
82 | ifeq ($(_tmp_tool_path),) | |
83 | missing_tools = $(ASCIIDOC) | |
84 | endif | |
85 | ||
ffef80ec | 86 | ifndef USE_ASCIIDOCTOR |
af3df2cf BP |
87 | _tmp_tool_path := $(call get-executable,$(XMLTO)) |
88 | ifeq ($(_tmp_tool_path),) | |
89 | missing_tools += $(XMLTO) | |
90 | endif | |
ffef80ec | 91 | endif |
af3df2cf | 92 | |
c1c2365a IM |
93 | # |
94 | # For asciidoc ... | |
95 | # -7.1.2, no extra settings are needed. | |
96 | # 8.0-, set ASCIIDOC8. | |
97 | # | |
98 | ||
99 | # | |
100 | # For docbook-xsl ... | |
101 | # -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0) | |
102 | # 1.69.0, no extra settings are needed? | |
103 | # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP? | |
104 | # 1.71.1, no extra settings are needed? | |
105 | # 1.72.0, set DOCBOOK_XSL_172. | |
106 | # 1.73.0-, set ASCIIDOC_NO_ROFF | |
107 | # | |
108 | ||
109 | # | |
110 | # If you had been using DOCBOOK_XSL_172 in an attempt to get rid | |
111 | # of 'the ".ft C" problem' in your generated manpages, and you | |
112 | # instead ended up with weird characters around callouts, try | |
113 | # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8). | |
114 | # | |
115 | ||
116 | ifdef ASCIIDOC8 | |
117 | ASCIIDOC_EXTRA += -a asciidoc7compatible | |
118 | endif | |
119 | ifdef DOCBOOK_XSL_172 | |
120 | ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff | |
121 | MANPAGE_XSL = manpage-1.72.xsl | |
122 | else | |
123 | ifdef ASCIIDOC_NO_ROFF | |
124 | # docbook-xsl after 1.72 needs the regular XSL, but will not | |
125 | # pass-thru raw roff codes from asciidoc.conf, so turn them off. | |
126 | ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff | |
127 | endif | |
128 | endif | |
129 | ifdef MAN_BOLD_LITERAL | |
130 | XMLTO_EXTRA += -m manpage-bold-literal.xsl | |
131 | endif | |
132 | ifdef DOCBOOK_SUPPRESS_SP | |
133 | XMLTO_EXTRA += -m manpage-suppress-sp.xsl | |
134 | endif | |
135 | ||
136 | SHELL_PATH ?= $(SHELL) | |
137 | # Shell quote; | |
138 | SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) | |
139 | ||
140 | # | |
141 | # Please note that there is a minor bug in asciidoc. | |
142 | # The version after 6.0.3 _will_ include the patch found here: | |
143 | # http://marc.theaimsgroup.com/?l=perf&m=111558757202243&w=2 | |
144 | # | |
145 | # Until that version is released you may have to apply the patch | |
146 | # yourself - yes, all 6 characters of it! | |
147 | # | |
148 | ||
149 | QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir | |
150 | QUIET_SUBDIR1 = | |
151 | ||
152 | ifneq ($(findstring $(MAKEFLAGS),w),w) | |
153 | PRINT_DIR = --no-print-directory | |
154 | else # "make -w" | |
155 | NO_SUBDIR = : | |
156 | endif | |
157 | ||
158 | ifneq ($(findstring $(MAKEFLAGS),s),s) | |
5125bc22 | 159 | ifneq ($(V),1) |
65fb0992 IM |
160 | QUIET_ASCIIDOC = @echo ' ASCIIDOC '$@; |
161 | QUIET_XMLTO = @echo ' XMLTO '$@; | |
162 | QUIET_DB2TEXI = @echo ' DB2TEXI '$@; | |
163 | QUIET_MAKEINFO = @echo ' MAKEINFO '$@; | |
164 | QUIET_DBLATEX = @echo ' DBLATEX '$@; | |
165 | QUIET_XSLTPROC = @echo ' XSLTPROC '$@; | |
166 | QUIET_GEN = @echo ' GEN '$@; | |
c1c2365a IM |
167 | QUIET_STDERR = 2> /dev/null |
168 | QUIET_SUBDIR0 = +@subdir= | |
65fb0992 IM |
169 | QUIET_SUBDIR1 = ;$(NO_SUBDIR) \ |
170 | echo ' SUBDIR ' $$subdir; \ | |
c1c2365a IM |
171 | $(MAKE) $(PRINT_DIR) -C $$subdir |
172 | export V | |
173 | endif | |
174 | endif | |
175 | ||
176 | all: html man | |
177 | ||
178 | html: $(DOC_HTML) | |
179 | ||
180 | $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf | |
181 | ||
182 | man: man1 man5 man7 | |
183 | man1: $(DOC_MAN1) | |
184 | man5: $(DOC_MAN5) | |
185 | man7: $(DOC_MAN7) | |
186 | ||
762b2935 | 187 | info: $(OUTPUT)perf.info $(OUTPUT)perfman.info |
c1c2365a | 188 | |
762b2935 | 189 | pdf: $(OUTPUT)user-manual.pdf |
c1c2365a IM |
190 | |
191 | install: install-man | |
192 | ||
af3df2cf BP |
193 | check-man-tools: |
194 | ifdef missing_tools | |
195 | $(error "You need to install $(missing_tools) for man pages") | |
196 | endif | |
197 | ||
198 | do-install-man: man | |
8a5411e9 IM |
199 | $(call QUIET_INSTALL, Documentation-man) \ |
200 | $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir); \ | |
201 | # $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir); \ | |
202 | # $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir); \ | |
203 | $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir); \ | |
204 | # $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir); \ | |
205 | # $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir) | |
c1c2365a | 206 | |
2826478a | 207 | install-man: check-man-tools man do-install-man |
af3df2cf | 208 | |
af3df2cf | 209 | ifdef missing_tools |
31f6be65 | 210 | DO_INSTALL_MAN = $(warning Please install $(missing_tools) to have the man pages installed) |
af3df2cf | 211 | else |
31f6be65 | 212 | DO_INSTALL_MAN = do-install-man |
af3df2cf BP |
213 | endif |
214 | ||
31f6be65 IM |
215 | try-install-man: $(DO_INSTALL_MAN) |
216 | ||
c1c2365a | 217 | install-info: info |
8a5411e9 IM |
218 | $(call QUIET_INSTALL, Documentation-info) \ |
219 | $(INSTALL) -d -m 755 $(DESTDIR)$(infodir); \ | |
220 | $(INSTALL) -m 644 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(DESTDIR)$(infodir); \ | |
c1c2365a | 221 | if test -r $(DESTDIR)$(infodir)/dir; then \ |
8a5411e9 IM |
222 | $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\ |
223 | $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\ | |
c1c2365a IM |
224 | else \ |
225 | echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \ | |
226 | fi | |
227 | ||
228 | install-pdf: pdf | |
8a5411e9 IM |
229 | $(call QUIET_INSTALL, Documentation-pdf) \ |
230 | $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir); \ | |
231 | $(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir) | |
c1c2365a | 232 | |
4187e262 JB |
233 | #install-html: html |
234 | # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) | |
c1c2365a | 235 | |
c1c2365a IM |
236 | |
237 | # | |
238 | # Determine "include::" file references in asciidoc files. | |
239 | # | |
762b2935 | 240 | $(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl |
c1c2365a IM |
241 | $(QUIET_GEN)$(RM) $@+ $@ && \ |
242 | $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \ | |
243 | mv $@+ $@ | |
244 | ||
762b2935 | 245 | -include $(OUPTUT)doc.dep |
c1c2365a | 246 | |
762b2935 | 247 | _cmds_txt = cmds-ancillaryinterrogators.txt \ |
c1c2365a IM |
248 | cmds-ancillarymanipulators.txt \ |
249 | cmds-mainporcelain.txt \ | |
250 | cmds-plumbinginterrogators.txt \ | |
251 | cmds-plumbingmanipulators.txt \ | |
252 | cmds-synchingrepositories.txt \ | |
253 | cmds-synchelpers.txt \ | |
254 | cmds-purehelpers.txt \ | |
255 | cmds-foreignscminterface.txt | |
762b2935 | 256 | cmds_txt=$(addprefix $(OUTPUT),$(_cmds_txt)) |
c1c2365a | 257 | |
762b2935 | 258 | $(cmds_txt): $(OUTPUT)cmd-list.made |
c1c2365a | 259 | |
762b2935 | 260 | $(OUTPUT)cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT) |
c1c2365a IM |
261 | $(QUIET_GEN)$(RM) $@ && \ |
262 | $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \ | |
263 | date >$@ | |
264 | ||
8ec19c0e IM |
265 | CLEAN_FILES = \ |
266 | $(MAN_XML) $(addsuffix +,$(MAN_XML)) \ | |
267 | $(MAN_HTML) $(addsuffix +,$(MAN_HTML)) \ | |
268 | $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7) \ | |
269 | $(OUTPUT)*.texi $(OUTPUT)*.texi+ $(OUTPUT)*.texi++ \ | |
270 | $(OUTPUT)perf.info $(OUTPUT)perfman.info \ | |
271 | $(OUTPUT)howto-index.txt $(OUTPUT)howto/*.html $(OUTPUT)doc.dep \ | |
272 | $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt \ | |
273 | $(cmds_txt) $(OUTPUT)*.made | |
c1c2365a | 274 | clean: |
8ec19c0e | 275 | $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES) |
762b2935 FBH |
276 | |
277 | $(MAN_HTML): $(OUTPUT)%.html : %.txt | |
c1c2365a | 278 | $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ |
ffef80ec TI |
279 | $(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \ |
280 | $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \ | |
281 | mv $@+ $@ | |
282 | ||
283 | ifdef USE_ASCIIDOCTOR | |
169e366c | 284 | $(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : %.txt |
ffef80ec TI |
285 | $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ |
286 | $(ASCIIDOC) -b manpage -d manpage \ | |
c1c2365a IM |
287 | $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \ |
288 | mv $@+ $@ | |
ffef80ec | 289 | endif |
c1c2365a | 290 | |
762b2935 | 291 | $(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml |
c1c2365a | 292 | $(QUIET_XMLTO)$(RM) $@ && \ |
761a0f39 | 293 | $(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< |
c1c2365a | 294 | |
762b2935 | 295 | $(OUTPUT)%.xml : %.txt |
c1c2365a | 296 | $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ |
ffef80ec | 297 | $(ASCIIDOC) -b docbook -d manpage \ |
c1c2365a IM |
298 | $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \ |
299 | mv $@+ $@ | |
300 | ||
301 | XSLT = docbook.xsl | |
302 | XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css | |
303 | ||
762b2935 | 304 | $(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml |
c1c2365a IM |
305 | $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $< |
306 | ||
762b2935 FBH |
307 | $(OUTPUT)perf.info: $(OUTPUT)user-manual.texi |
308 | $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi | |
c1c2365a | 309 | |
762b2935 | 310 | $(OUTPUT)user-manual.texi: $(OUTPUT)user-manual.xml |
c1c2365a | 311 | $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ |
762b2935 | 312 | $(DOCBOOK2X_TEXI) $(OUTPUT)user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \ |
c1c2365a IM |
313 | $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \ |
314 | rm $@++ && \ | |
315 | mv $@+ $@ | |
316 | ||
762b2935 | 317 | $(OUTPUT)user-manual.pdf: $(OUTPUT)user-manual.xml |
c1c2365a IM |
318 | $(QUIET_DBLATEX)$(RM) $@+ $@ && \ |
319 | $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \ | |
320 | mv $@+ $@ | |
321 | ||
762b2935 | 322 | $(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl |
c1c2365a IM |
323 | $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ |
324 | ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \ | |
325 | --to-stdout $(xml) &&) true) > $@++ && \ | |
326 | $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \ | |
327 | rm $@++ && \ | |
328 | mv $@+ $@ | |
329 | ||
762b2935 | 330 | $(OUTPUT)perfman.info: $(OUTPUT)perfman.texi |
c1c2365a IM |
331 | $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi |
332 | ||
333 | $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml | |
334 | $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ | |
335 | $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \ | |
336 | mv $@+ $@ | |
337 | ||
338 | howto-index.txt: howto-index.sh $(wildcard howto/*.txt) | |
339 | $(QUIET_GEN)$(RM) $@+ $@ && \ | |
340 | '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \ | |
341 | mv $@+ $@ | |
342 | ||
343 | $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt | |
ffef80ec | 344 | $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $*.txt |
c1c2365a IM |
345 | |
346 | WEBDOC_DEST = /pub/software/tools/perf/docs | |
347 | ||
348 | $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt | |
349 | $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ | |
ffef80ec | 350 | sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b $(ASCIIDOC_HTML) - >$@+ && \ |
c1c2365a IM |
351 | mv $@+ $@ |
352 | ||
4187e262 JB |
353 | # UNIMPLEMENTED |
354 | #install-webdoc : html | |
355 | # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST) | |
c1c2365a | 356 | |
4187e262 | 357 | # quick-install: quick-install-man |
c1c2365a | 358 | |
4187e262 JB |
359 | # quick-install-man: |
360 | # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir) | |
c1c2365a | 361 | |
4187e262 JB |
362 | #quick-install-html: |
363 | # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir) |