Makefile 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. # SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
  2. # Most of this file is copied from tools/perf/Documentation/Makefile
  3. include ../../../scripts/Makefile.include
  4. include ../../../scripts/utilities.mak
  5. MAN3_TXT = libperf.txt
  6. MAN7_TXT = libperf-counting.txt libperf-sampling.txt
  7. MAN_EX = examples/*.c
  8. MAN_TXT = $(MAN3_TXT) $(MAN7_TXT)
  9. _MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
  10. _MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
  11. _MAN_3 = $(patsubst %.txt,%.3,$(MAN3_TXT))
  12. _MAN_7 = $(patsubst %.txt,%.7,$(MAN7_TXT))
  13. MAN_XML = $(addprefix $(OUTPUT),$(_MAN_XML))
  14. MAN_HTML = $(addprefix $(OUTPUT),$(_MAN_HTML))
  15. MAN_3 = $(addprefix $(OUTPUT),$(_MAN_3))
  16. MAN_7 = $(addprefix $(OUTPUT),$(_MAN_7))
  17. MAN_X = $(MAN_3) $(MAN_7)
  18. # Make the path relative to DESTDIR, not prefix
  19. ifndef DESTDIR
  20. prefix ?=$(HOME)
  21. endif
  22. mandir ?= $(prefix)/share/man
  23. man3dir = $(mandir)/man3
  24. man7dir = $(mandir)/man7
  25. docdir ?= $(prefix)/share/doc/libperf
  26. htmldir = $(docdir)/html
  27. exdir = $(docdir)/examples
  28. ASCIIDOC = asciidoc
  29. ASCIIDOC_EXTRA = --unsafe -f asciidoc.conf
  30. ASCIIDOC_HTML = xhtml11
  31. MANPAGE_XSL = manpage-normal.xsl
  32. XMLTO_EXTRA =
  33. XMLTO =xmlto
  34. INSTALL ?= install
  35. RM ?= rm -f
  36. # For asciidoc ...
  37. # -7.1.2, no extra settings are needed.
  38. # 8.0-, set ASCIIDOC8.
  39. #
  40. # For docbook-xsl ...
  41. # -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
  42. # 1.69.0, no extra settings are needed?
  43. # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
  44. # 1.71.1, no extra settings are needed?
  45. # 1.72.0, set DOCBOOK_XSL_172.
  46. # 1.73.0-, set ASCIIDOC_NO_ROFF
  47. # If you had been using DOCBOOK_XSL_172 in an attempt to get rid
  48. # of 'the ".ft C" problem' in your generated manpages, and you
  49. # instead ended up with weird characters around callouts, try
  50. # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
  51. ifdef ASCIIDOC8
  52. ASCIIDOC_EXTRA += -a asciidoc7compatible
  53. endif
  54. ifdef DOCBOOK_XSL_172
  55. ASCIIDOC_EXTRA += -a libperf-asciidoc-no-roff
  56. MANPAGE_XSL = manpage-1.72.xsl
  57. else
  58. ifdef ASCIIDOC_NO_ROFF
  59. # docbook-xsl after 1.72 needs the regular XSL, but will not
  60. # pass-thru raw roff codes from asciidoc.conf, so turn them off.
  61. ASCIIDOC_EXTRA += -a libperf-asciidoc-no-roff
  62. endif
  63. endif
  64. ifdef MAN_BOLD_LITERAL
  65. XMLTO_EXTRA += -m manpage-bold-literal.xsl
  66. endif
  67. ifdef DOCBOOK_SUPPRESS_SP
  68. XMLTO_EXTRA += -m manpage-suppress-sp.xsl
  69. endif
  70. DESTDIR ?=
  71. DESTDIR_SQ = '$(subst ','\'',$(DESTDIR))'
  72. export DESTDIR DESTDIR_SQ
  73. # Please note that there is a minor bug in asciidoc.
  74. # The version after 6.0.3 _will_ include the patch found here:
  75. # http://marc.theaimsgroup.com/?l=libtraceevent&m=111558757202243&w=2
  76. #
  77. # Until that version is released you may have to apply the patch
  78. # yourself - yes, all 6 characters of it!
  79. QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
  80. QUIET_SUBDIR1 =
  81. ifneq ($(findstring $(MAKEFLAGS),w),w)
  82. PRINT_DIR = --no-print-directory
  83. else # "make -w"
  84. NO_SUBDIR = :
  85. endif
  86. ifneq ($(findstring $(MAKEFLAGS),s),s)
  87. ifneq ($(V),1)
  88. QUIET_ASCIIDOC = @echo ' ASCIIDOC '$@;
  89. QUIET_XMLTO = @echo ' XMLTO '$@;
  90. endif
  91. endif
  92. all: $(MAN_X) $(MAN_HTML)
  93. $(MAN_HTML) $(MAN_X): asciidoc.conf
  94. install-man: all
  95. $(call QUIET_INSTALL, man) \
  96. $(INSTALL) -d -m 755 $(DESTDIR)$(man3dir); \
  97. $(INSTALL) -m 644 $(MAN_3) $(DESTDIR)$(man3dir); \
  98. $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir); \
  99. $(INSTALL) -m 644 $(MAN_7) $(DESTDIR)$(man7dir);
  100. install-html:
  101. $(call QUIET_INSTALL, html) \
  102. $(INSTALL) -d -m 755 $(DESTDIR)$(htmldir); \
  103. $(INSTALL) -m 644 $(MAN_HTML) $(DESTDIR)$(htmldir); \
  104. install-examples:
  105. $(call QUIET_INSTALL, examples) \
  106. $(INSTALL) -d -m 755 $(DESTDIR)$(exdir); \
  107. $(INSTALL) -m 644 $(MAN_EX) $(DESTDIR)$(exdir); \
  108. CLEAN_FILES = \
  109. $(MAN_XML) $(addsuffix +,$(MAN_XML)) \
  110. $(MAN_HTML) $(addsuffix +,$(MAN_HTML)) \
  111. $(MAN_X)
  112. clean:
  113. $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES)
  114. $(MAN_3): $(OUTPUT)%.3: %.xml
  115. $(QUIET_XMLTO)$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
  116. $(MAN_7): $(OUTPUT)%.7: %.xml
  117. $(QUIET_XMLTO)$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
  118. $(MAN_XML): $(OUTPUT)%.xml: %.txt
  119. $(QUIET_ASCIIDOC)$(ASCIIDOC) -b docbook -d manpage \
  120. $(ASCIIDOC_EXTRA) -alibperf_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
  121. mv $@+ $@
  122. $(MAN_HTML): $(OUTPUT)%.html: %.txt
  123. $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \
  124. $(ASCIIDOC_EXTRA) -aperf_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
  125. mv $@+ $@