Makefile 8.3 KB

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