Loading...
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
253ifdef USE_ASCIIDOCTOR
254$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : %.txt
255 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
256 $(ASCIIDOC) -b manpage -d manpage \
257 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
258 mv $@+ $@
259endif
260
261$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml
262 $(QUIET_XMLTO)$(RM) $@ && \
263 $(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
264
265$(OUTPUT)%.xml : %.txt
266 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
267 $(ASCIIDOC) -b docbook -d manpage \
268 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) \
269 -aperf_date=$(shell git log -1 --pretty="format:%cd" \
270 --date=short --no-show-signature $<) \
271 -o $@+ $< && \
272 mv $@+ $@
273
274XSLT = docbook.xsl
275XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
276
277$(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl
278 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
279 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
280 --to-stdout $(xml) &&) true) > $@++ && \
281 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
282 rm $@++ && \
283 mv $@+ $@
284
285$(OUTPUT)perfman.info: $(OUTPUT)perfman.texi
286 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate -o $@ $*.texi
287
288$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
289 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
290 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
291 mv $@+ $@
292
293$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
294 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $*.txt
295
296WEBDOC_DEST = /pub/software/tools/perf/docs
297
298# UNIMPLEMENTED
299#install-webdoc : html
300# '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
301
302# quick-install: quick-install-man
303
304# quick-install-man:
305# '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
306
307#quick-install-html:
308# '$(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
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)