1 include ../config/utilities.mak
4 ifeq ("$(origin O)", "command line")
11 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
12 $(wildcard perf-*.txt)) \
17 MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
18 _MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
19 _MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
21 MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))
22 MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))
25 # with their own formatting rules.
27 API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
28 SP_ARTICLES += $(API_DOCS)
29 SP_ARTICLES += technical/api-index
31 _DOC_HTML = $(_MAN_HTML)
32 _DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
33 DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML))
35 _DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
36 _DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
37 _DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
39 DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1))
40 DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5))
41 DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7))
43 # Make the path relative to DESTDIR, not prefix
48 htmldir?=$(prefix)/share/doc/perf-doc
49 pdfdir?=$(prefix)/share/doc/perf-doc
50 mandir?=$(prefix)/share/man
51 man1dir=$(mandir)/man1
52 man5dir=$(mandir)/man5
53 man7dir=$(mandir)/man7
56 ASCIIDOC_EXTRA = --unsafe
57 MANPAGE_XSL = manpage-normal.xsl
62 HTML_REF = origin/html
64 infodir?=$(prefix)/share/info
66 INSTALL_INFO=install-info
67 DOCBOOK2X_TEXI=docbook2x-texi
71 PERL_PATH = /usr/bin/perl
74 -include ../config.mak.autogen
75 -include ../config.mak
77 _tmp_tool_path := $(call get-executable,$(ASCIIDOC))
78 ifeq ($(_tmp_tool_path),)
79 missing_tools = $(ASCIIDOC)
82 _tmp_tool_path := $(call get-executable,$(XMLTO))
83 ifeq ($(_tmp_tool_path),)
84 missing_tools += $(XMLTO)
89 # -7.1.2, no extra settings are needed.
90 # 8.0-, set ASCIIDOC8.
95 # -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
96 # 1.69.0, no extra settings are needed?
97 # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
98 # 1.71.1, no extra settings are needed?
99 # 1.72.0, set DOCBOOK_XSL_172.
100 # 1.73.0-, set ASCIIDOC_NO_ROFF
104 # If you had been using DOCBOOK_XSL_172 in an attempt to get rid
105 # of 'the ".ft C" problem' in your generated manpages, and you
106 # instead ended up with weird characters around callouts, try
107 # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
111 ASCIIDOC_EXTRA += -a asciidoc7compatible
113 ifdef DOCBOOK_XSL_172
114 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
115 MANPAGE_XSL = manpage-1.72.xsl
117 ifdef ASCIIDOC_NO_ROFF
118 # docbook-xsl after 1.72 needs the regular XSL, but will not
119 # pass-thru raw roff codes from asciidoc.conf, so turn them off.
120 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
123 ifdef MAN_BOLD_LITERAL
124 XMLTO_EXTRA += -m manpage-bold-literal.xsl
126 ifdef DOCBOOK_SUPPRESS_SP
127 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
130 SHELL_PATH ?= $(SHELL)
132 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
135 # Please note that there is a minor bug in asciidoc.
136 # The version after 6.0.3 _will_ include the patch found here:
137 # http://marc.theaimsgroup.com/?l=perf&m=111558757202243&w=2
139 # Until that version is released you may have to apply the patch
140 # yourself - yes, all 6 characters of it!
143 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
146 ifneq ($(findstring $(MAKEFLAGS),w),w)
147 PRINT_DIR = --no-print-directory
152 ifneq ($(findstring $(MAKEFLAGS),s),s)
154 QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
155 QUIET_XMLTO = @echo ' ' XMLTO $@;
156 QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
157 QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
158 QUIET_DBLATEX = @echo ' ' DBLATEX $@;
159 QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
160 QUIET_GEN = @echo ' ' GEN $@;
161 QUIET_STDERR = 2> /dev/null
162 QUIET_SUBDIR0 = +@subdir=
163 QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
164 $(MAKE) $(PRINT_DIR) -C $$subdir
173 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
180 info: $(OUTPUT)perf.info $(OUTPUT)perfman.info
182 pdf: $(OUTPUT)user-manual.pdf
188 $(error "You need to install $(missing_tools) for man pages")
192 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
193 # $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
194 # $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
195 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir)
196 # $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir)
197 # $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
199 install-man: check-man-tools man
203 $(warning Please install $(missing_tools) to have the man pages installed)
205 $(MAKE) do-install-man
209 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir)
210 $(INSTALL) -m 644 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(DESTDIR)$(infodir)
211 if test -r $(DESTDIR)$(infodir)/dir; then \
212 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\
213 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\
215 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
219 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
220 $(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir)
223 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
225 ifneq ($(MAKECMDGOALS),clean)
226 ifneq ($(MAKECMDGOALS),tags)
227 $(OUTPUT)PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE
228 $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) $(OUTPUT)PERF-VERSION-FILE
230 -include $(OUTPUT)PERF-VERSION-FILE
235 # Determine "include::" file references in asciidoc files.
237 $(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl
238 $(QUIET_GEN)$(RM) $@+ $@ && \
239 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
242 -include $(OUPTUT)doc.dep
244 _cmds_txt = cmds-ancillaryinterrogators.txt \
245 cmds-ancillarymanipulators.txt \
246 cmds-mainporcelain.txt \
247 cmds-plumbinginterrogators.txt \
248 cmds-plumbingmanipulators.txt \
249 cmds-synchingrepositories.txt \
250 cmds-synchelpers.txt \
251 cmds-purehelpers.txt \
252 cmds-foreignscminterface.txt
253 cmds_txt=$(addprefix $(OUTPUT),$(_cmds_txt))
255 $(cmds_txt): $(OUTPUT)cmd-list.made
257 $(OUTPUT)cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
258 $(QUIET_GEN)$(RM) $@ && \
259 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
263 $(RM) $(MAN_XML) $(addsuffix +,$(MAN_XML))
264 $(RM) $(MAN_HTML) $(addsuffix +,$(MAN_HTML))
265 $(RM) $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7)
266 $(RM) $(OUTPUT)*.texi $(OUTPUT)*.texi+ $(OUTPUT)*.texi++
267 $(RM) $(OUTPUT)perf.info $(OUTPUT)perfman.info
268 $(RM) $(OUTPUT)howto-index.txt $(OUTPUT)howto/*.html $(OUTPUT)doc.dep
269 $(RM) $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt
270 $(RM) $(cmds_txt) $(OUTPUT)*.made
272 $(MAN_HTML): $(OUTPUT)%.html : %.txt
273 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
274 $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
275 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
278 $(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml
279 $(QUIET_XMLTO)$(RM) $@ && \
280 $(XMLTO) -o $(OUTPUT) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
282 $(OUTPUT)%.xml : %.txt
283 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
284 $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
285 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
289 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
291 $(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml
292 $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
294 $(OUTPUT)perf.info: $(OUTPUT)user-manual.texi
295 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi
297 $(OUTPUT)user-manual.texi: $(OUTPUT)user-manual.xml
298 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
299 $(DOCBOOK2X_TEXI) $(OUTPUT)user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
300 $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
304 $(OUTPUT)user-manual.pdf: $(OUTPUT)user-manual.xml
305 $(QUIET_DBLATEX)$(RM) $@+ $@ && \
306 $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
309 $(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl
310 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
311 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
312 --to-stdout $(xml) &&) true) > $@++ && \
313 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
317 $(OUTPUT)perfman.info: $(OUTPUT)perfman.texi
318 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
320 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
321 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
322 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
325 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
326 $(QUIET_GEN)$(RM) $@+ $@ && \
327 '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
330 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
331 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
333 WEBDOC_DEST = /pub/software/tools/perf/docs
335 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
336 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
337 sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
341 #install-webdoc : html
342 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
344 # quick-install: quick-install-man
347 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
350 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
352 .PHONY: .FORCE-PERF-VERSION-FILE