Makefile 10 KB

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