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