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