perf tools: Don't check configuration on make clean
[~shefty/rdma-dev.git] / tools / perf / Documentation / Makefile
1 include ../config/utilities.mak
2
3 OUTPUT := ./
4 ifeq ("$(origin O)", "command line")
5   ifneq ($(O),)
6         OUTPUT := $(O)/
7   endif
8 endif
9
10 MAN1_TXT= \
11         $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
12                 $(wildcard perf-*.txt)) \
13         perf.txt
14 MAN5_TXT=
15 MAN7_TXT=
16
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))
20
21 MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))
22 MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))
23
24 ARTICLES =
25 # with their own formatting rules.
26 SP_ARTICLES =
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
30
31 _DOC_HTML = $(_MAN_HTML)
32 _DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
33 DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML))
34
35 _DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))
36 _DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))
37 _DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))
38
39 DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1))
40 DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5))
41 DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7))
42
43 # Make the path relative to DESTDIR, not prefix
44 ifndef DESTDIR
45 prefix?=$(HOME)
46 endif
47 bindir?=$(prefix)/bin
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
54
55 ASCIIDOC=asciidoc
56 ASCIIDOC_EXTRA = --unsafe
57 MANPAGE_XSL = manpage-normal.xsl
58 XMLTO_EXTRA =
59 INSTALL?=install
60 RM ?= rm -f
61 DOC_REF = origin/man
62 HTML_REF = origin/html
63
64 infodir?=$(prefix)/share/info
65 MAKEINFO=makeinfo
66 INSTALL_INFO=install-info
67 DOCBOOK2X_TEXI=docbook2x-texi
68 DBLATEX=dblatex
69 XMLTO=xmlto
70 ifndef PERL_PATH
71         PERL_PATH = /usr/bin/perl
72 endif
73
74 -include ../config.mak.autogen
75 -include ../config.mak
76
77 _tmp_tool_path := $(call get-executable,$(ASCIIDOC))
78 ifeq ($(_tmp_tool_path),)
79         missing_tools = $(ASCIIDOC)
80 endif
81
82 _tmp_tool_path := $(call get-executable,$(XMLTO))
83 ifeq ($(_tmp_tool_path),)
84         missing_tools += $(XMLTO)
85 endif
86
87 #
88 # For asciidoc ...
89 #       -7.1.2, no extra settings are needed.
90 #       8.0-,   set ASCIIDOC8.
91 #
92
93 #
94 # For docbook-xsl ...
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
101 #
102
103 #
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).
108 #
109
110 ifdef ASCIIDOC8
111 ASCIIDOC_EXTRA += -a asciidoc7compatible
112 endif
113 ifdef DOCBOOK_XSL_172
114 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
115 MANPAGE_XSL = manpage-1.72.xsl
116 else
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
121         endif
122 endif
123 ifdef MAN_BOLD_LITERAL
124 XMLTO_EXTRA += -m manpage-bold-literal.xsl
125 endif
126 ifdef DOCBOOK_SUPPRESS_SP
127 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
128 endif
129
130 SHELL_PATH ?= $(SHELL)
131 # Shell quote;
132 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
133
134 #
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
138 #
139 # Until that version is released you may have to apply the patch
140 # yourself - yes, all 6 characters of it!
141 #
142
143 QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
144 QUIET_SUBDIR1  =
145
146 ifneq ($(findstring $(MAKEFLAGS),w),w)
147 PRINT_DIR = --no-print-directory
148 else # "make -w"
149 NO_SUBDIR = :
150 endif
151
152 ifneq ($(findstring $(MAKEFLAGS),s),s)
153 ifndef V
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
165         export V
166 endif
167 endif
168
169 all: html man
170
171 html: $(DOC_HTML)
172
173 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
174
175 man: man1 man5 man7
176 man1: $(DOC_MAN1)
177 man5: $(DOC_MAN5)
178 man7: $(DOC_MAN7)
179
180 info: $(OUTPUT)perf.info $(OUTPUT)perfman.info
181
182 pdf: $(OUTPUT)user-manual.pdf
183
184 install: install-man
185
186 check-man-tools:
187 ifdef missing_tools
188         $(error "You need to install $(missing_tools) for man pages")
189 endif
190
191 do-install-man: man
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)
198
199 install-man: check-man-tools man
200
201 try-install-man:
202 ifdef missing_tools
203         $(warning Please install $(missing_tools) to have the man pages installed)
204 else
205         $(MAKE) do-install-man
206 endif
207
208 install-info: info
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 ;\
214         else \
215           echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \
216         fi
217
218 install-pdf: pdf
219         $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)
220         $(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir)
221
222 #install-html: html
223 #       '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
224
225 ifneq ($(MAKECMDGOALS),clean)
226 $(OUTPUT)PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE
227         $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) $(OUTPUT)PERF-VERSION-FILE
228
229 -include $(OUTPUT)PERF-VERSION-FILE
230 endif
231
232 #
233 # Determine "include::" file references in asciidoc files.
234 #
235 $(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl
236         $(QUIET_GEN)$(RM) $@+ $@ && \
237         $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
238         mv $@+ $@
239
240 -include $(OUPTUT)doc.dep
241
242 _cmds_txt = cmds-ancillaryinterrogators.txt \
243         cmds-ancillarymanipulators.txt \
244         cmds-mainporcelain.txt \
245         cmds-plumbinginterrogators.txt \
246         cmds-plumbingmanipulators.txt \
247         cmds-synchingrepositories.txt \
248         cmds-synchelpers.txt \
249         cmds-purehelpers.txt \
250         cmds-foreignscminterface.txt
251 cmds_txt=$(addprefix $(OUTPUT),$(_cmds_txt))
252
253 $(cmds_txt): $(OUTPUT)cmd-list.made
254
255 $(OUTPUT)cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
256         $(QUIET_GEN)$(RM) $@ && \
257         $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
258         date >$@
259
260 clean:
261         $(RM) $(MAN_XML) $(addsuffix +,$(MAN_XML))
262         $(RM) $(MAN_HTML) $(addsuffix +,$(MAN_HTML))
263         $(RM) $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7)
264         $(RM) $(OUTPUT)*.texi $(OUTPUT)*.texi+ $(OUTPUT)*.texi++
265         $(RM) $(OUTPUT)perf.info $(OUTPUT)perfman.info
266         $(RM) $(OUTPUT)howto-index.txt $(OUTPUT)howto/*.html $(OUTPUT)doc.dep
267         $(RM) $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt
268         $(RM) $(cmds_txt) $(OUTPUT)*.made
269
270 $(MAN_HTML): $(OUTPUT)%.html : %.txt
271         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
272         $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \
273                 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
274         mv $@+ $@
275
276 $(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml
277         $(QUIET_XMLTO)$(RM) $@ && \
278         $(XMLTO) -o $(OUTPUT) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
279
280 $(OUTPUT)%.xml : %.txt
281         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
282         $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
283                 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
284         mv $@+ $@
285
286 XSLT = docbook.xsl
287 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
288
289 $(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml
290         $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
291
292 $(OUTPUT)perf.info: $(OUTPUT)user-manual.texi
293         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi
294
295 $(OUTPUT)user-manual.texi: $(OUTPUT)user-manual.xml
296         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
297         $(DOCBOOK2X_TEXI) $(OUTPUT)user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
298         $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
299         rm $@++ && \
300         mv $@+ $@
301
302 $(OUTPUT)user-manual.pdf: $(OUTPUT)user-manual.xml
303         $(QUIET_DBLATEX)$(RM) $@+ $@ && \
304         $(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \
305         mv $@+ $@
306
307 $(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl
308         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
309         ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
310                 --to-stdout $(xml) &&) true) > $@++ && \
311         $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
312         rm $@++ && \
313         mv $@+ $@
314
315 $(OUTPUT)perfman.info: $(OUTPUT)perfman.texi
316         $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
317
318 $(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
319         $(QUIET_DB2TEXI)$(RM) $@+ $@ && \
320         $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
321         mv $@+ $@
322
323 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
324         $(QUIET_GEN)$(RM) $@+ $@ && \
325         '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
326         mv $@+ $@
327
328 $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
329         $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 $*.txt
330
331 WEBDOC_DEST = /pub/software/tools/perf/docs
332
333 $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
334         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
335         sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b xhtml11 - >$@+ && \
336         mv $@+ $@
337
338 # UNIMPLEMENTED
339 #install-webdoc : html
340 #       '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
341
342 # quick-install: quick-install-man
343
344 # quick-install-man:
345 #       '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
346
347 #quick-install-html:
348 #       '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)
349
350 .PHONY: .FORCE-PERF-VERSION-FILE