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