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