2 ifeq ("$(origin O)", "command line")
9 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
10 $(wildcard perf-*.txt)) \
15 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
16 _MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
17 _MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
19 MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))
20 MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))
23 # with their own formatting rules.
25 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
26 SP_ARTICLES += $(API_DOCS)
27 SP_ARTICLES += technical/api-index
29 _DOC_HTML = $(_MAN_HTML)
30 _DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
31 DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML))
33 _DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
34 _DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
35 _DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
37 DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1))
38 DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5))
39 DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7))
41 # Make the path relative to DESTDIR, not prefix
46 htmldir?=$(prefix)/share/doc/perf-doc
47 pdfdir?=$(prefix)/share/doc/perf-doc
48 mandir?=$(prefix)/share/man
49 man1dir=$(mandir)/man1
50 man5dir=$(mandir)/man5
51 man7dir=$(mandir)/man7
54 ASCIIDOC_EXTRA = --unsafe
55 MANPAGE_XSL = manpage-normal.xsl
60 HTML_REF = origin/html
62 infodir?=$(prefix)/share/info
64 INSTALL_INFO=install-info
65 DOCBOOK2X_TEXI=docbook2x-texi
68 PERL_PATH = /usr/bin/perl
71 -include ../config.mak.autogen
72 -include ../config.mak
76 # -7.1.2, no extra settings are needed.
77 # 8.0-, set ASCIIDOC8.
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
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).
98 ASCIIDOC_EXTRA += -a asciidoc7compatible
100 ifdef DOCBOOK_XSL_172
101 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
102 MANPAGE_XSL = manpage-1.72.xsl
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
110 ifdef MAN_BOLD_LITERAL
111 XMLTO_EXTRA += -m manpage-bold-literal.xsl
113 ifdef DOCBOOK_SUPPRESS_SP
114 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
117 SHELL_PATH ?= $(SHELL)
119 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
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
126 # Until that version is released you may have to apply the patch
127 # yourself - yes, all 6 characters of it!
130 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
133 ifneq ($(findstring $(MAKEFLAGS),w),w)
134 PRINT_DIR = --no-print-directory
139 ifneq ($(findstring $(MAKEFLAGS),s),s)
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
160 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
167 info: $(OUTPUT)perf.info $(OUTPUT)perfman.info
169 pdf: $(OUTPUT)user-manual.pdf
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)
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 ;\
188 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
192 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
193 $(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir)
196 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
198 $(OUTPUT)PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE
199 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) $(OUTPUT)PERF-VERSION-FILE
201 -include $(OUTPUT)PERF-VERSION-FILE
204 # Determine "include::" file references in asciidoc files.
206 $(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl
207 $(QUIET_GEN)$(RM) $@+ $@ && \
208 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
211 -include $(OUPTUT)doc.dep
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
222 cmds_txt=$(addprefix $(OUTPUT),$(_cmds_txt))
224 $(cmds_txt): $(OUTPUT)cmd-list.made
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) && \
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
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 $@+ $< && \
247 $(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml
248 $(QUIET_XMLTO)$(RM) $@ && \
249 xmlto -o $(OUTPUT) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
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 $@+ $< && \
258 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
260 $(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml
261 $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
263 $(OUTPUT)perf.info: $(OUTPUT)user-manual.texi
264 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi
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 <$@++ >$@+ && \
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 $< && \
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 $@ <$@++ >$@+ && \
286 $(OUTPUT)perfman.info: $(OUTPUT)perfman.texi
287 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
289 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
290 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
291 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
294 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
295 $(QUIET_GEN)$(RM) $@+ $@ && \
296 '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
299 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
300 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
302 WEBDOC_DEST = /pub/software/tools/perf/docs
304 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
305 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
306 sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
310 #install-webdoc : html
311 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
313 # quick-install: quick-install-man
316 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
319 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
321 .PHONY: .FORCE-PERF-VERSION-FILE