OSCL-LXR

0001 # SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
0002 # Most of this file is copied from tools/perf/Documentation/Makefile
0003
0004 include ../../../scripts/Makefile.include
0005 include ../../../scripts/utilities.mak
0006
0007 MAN3_TXT  = libperf.txt
0008 MAN7_TXT  = libperf-counting.txt libperf-sampling.txt
0009 MAN_EX    = examples/*.c
0010
0011 MAN_TXT   = $(MAN3_TXT) $(MAN7_TXT)
0012
0013 _MAN_XML  = $(patsubst %.txt,%.xml,$(MAN_TXT))
0014 _MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
0015 _MAN_3    = $(patsubst %.txt,%.3,$(MAN3_TXT))
0016 _MAN_7    = $(patsubst %.txt,%.7,$(MAN7_TXT))
0017
0018 MAN_XML   = $(addprefix $(OUTPUT),$(_MAN_XML))
0019 MAN_HTML  = $(addprefix $(OUTPUT),$(_MAN_HTML))
0020 MAN_3     = $(addprefix $(OUTPUT),$(_MAN_3))
0021 MAN_7     = $(addprefix $(OUTPUT),$(_MAN_7))
0022 MAN_X     = $(MAN_3) $(MAN_7)
0023
0024 # Make the path relative to DESTDIR, not prefix
0025 ifndef DESTDIR
0026   prefix ?=$(HOME)
0027 endif
0028
0029 mandir  ?= $(prefix)/share/man
0030 man3dir  = $(mandir)/man3
0031 man7dir  = $(mandir)/man7
0032
0033 docdir  ?= $(prefix)/share/doc/libperf
0034 htmldir  = $(docdir)/html
0035 exdir    = $(docdir)/examples
0036
0037 ASCIIDOC        = asciidoc
0038 ASCIIDOC_EXTRA  = --unsafe -f asciidoc.conf
0039 ASCIIDOC_HTML   = xhtml11
0040 MANPAGE_XSL     = manpage-normal.xsl
0041 XMLTO_EXTRA     =
0042 XMLTO           =xmlto
0043
0044 INSTALL ?= install
0045 RM      ?= rm -f
0046
0047 # For asciidoc ...
0048 #       -7.1.2, no extra settings are needed.
0049 #       8.0-,   set ASCIIDOC8.
0050 #
0051
0052 # For docbook-xsl ...
0053 #       -1.68.1,        set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
0054 #       1.69.0,         no extra settings are needed?
0055 #       1.69.1-1.71.0,  set DOCBOOK_SUPPRESS_SP?
0056 #       1.71.1,         no extra settings are needed?
0057 #       1.72.0,         set DOCBOOK_XSL_172.
0058 #       1.73.0-,        set ASCIIDOC_NO_ROFF
0059
0060 # If you had been using DOCBOOK_XSL_172 in an attempt to get rid
0061 # of 'the ".ft C" problem' in your generated manpages, and you
0062 # instead ended up with weird characters around callouts, try
0063 # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
0064
0065 ifdef ASCIIDOC8
0066   ASCIIDOC_EXTRA += -a asciidoc7compatible
0067 endif
0068 ifdef DOCBOOK_XSL_172
0069   ASCIIDOC_EXTRA += -a libperf-asciidoc-no-roff
0070   MANPAGE_XSL = manpage-1.72.xsl
0071 else
0072   ifdef ASCIIDOC_NO_ROFF
0073     # docbook-xsl after 1.72 needs the regular XSL, but will not
0074     # pass-thru raw roff codes from asciidoc.conf, so turn them off.
0075     ASCIIDOC_EXTRA += -a libperf-asciidoc-no-roff
0076   endif
0077 endif
0078 ifdef MAN_BOLD_LITERAL
0079   XMLTO_EXTRA += -m manpage-bold-literal.xsl
0080 endif
0081 ifdef DOCBOOK_SUPPRESS_SP
0082   XMLTO_EXTRA += -m manpage-suppress-sp.xsl
0083 endif
0084
0085 DESTDIR ?=
0086 DESTDIR_SQ = '$(subst ','\'',$(DESTDIR))'
0087
0088 export DESTDIR DESTDIR_SQ
0089
0090 # Please note that there is a minor bug in asciidoc.
0091 # The version after 6.0.3 _will_ include the patch found here:
0092 #   http://marc.theaimsgroup.com/?l=libtraceevent&m=111558757202243&w=2
0093 #
0094 # Until that version is released you may have to apply the patch
0095 # yourself - yes, all 6 characters of it!
0096
0097 QUIET_SUBDIR0  = +$(MAKE) -C # space to separate -C and subdir
0098 QUIET_SUBDIR1  =
0099
0100 ifneq ($(findstring $(MAKEFLAGS),w),w)
0101   PRINT_DIR = --no-print-directory
0102 else # "make -w"
0103   NO_SUBDIR = :
0104 endif
0105
0106 ifneq ($(findstring $(MAKEFLAGS),s),s)
0107   ifneq ($(V),1)
0108     QUIET_ASCIIDOC = @echo '  ASCIIDOC '$@;
0109     QUIET_XMLTO    = @echo '  XMLTO    '$@;
0110   endif
0111 endif
0112
0113 all: $(MAN_X) $(MAN_HTML)
0114
0115 $(MAN_HTML) $(MAN_X): asciidoc.conf
0116
0117 install-man: all
0118         $(call QUIET_INSTALL, man) \
0119                 $(INSTALL) -d -m 755 $(DESTDIR)$(man3dir); \
0120                 $(INSTALL) -m 644 $(MAN_3) $(DESTDIR)$(man3dir); \
0121                 $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir); \
0122                 $(INSTALL) -m 644 $(MAN_7) $(DESTDIR)$(man7dir);
0123
0124 install-html:
0125         $(call QUIET_INSTALL, html) \
0126                 $(INSTALL) -d -m 755 $(DESTDIR)$(htmldir); \
0127                 $(INSTALL) -m 644 $(MAN_HTML) $(DESTDIR)$(htmldir); \
0128
0129 install-examples:
0130         $(call QUIET_INSTALL, examples) \
0131                 $(INSTALL) -d -m 755 $(DESTDIR)$(exdir); \
0132                 $(INSTALL) -m 644 $(MAN_EX) $(DESTDIR)$(exdir); \
0133
0134 CLEAN_FILES =                                   \
0135         $(MAN_XML) $(addsuffix +,$(MAN_XML))    \
0136         $(MAN_HTML) $(addsuffix +,$(MAN_HTML))  \
0137         $(MAN_X)
0138
0139 clean:
0140         $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES)
0141
0142 $(MAN_3): $(OUTPUT)%.3: %.xml
0143         $(QUIET_XMLTO)$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
0144
0145 $(MAN_7): $(OUTPUT)%.7: %.xml
0146         $(QUIET_XMLTO)$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
0147
0148 $(MAN_XML): $(OUTPUT)%.xml: %.txt
0149         $(QUIET_ASCIIDOC)$(ASCIIDOC) -b docbook -d manpage \
0150                 $(ASCIIDOC_EXTRA) -alibperf_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
0151         mv $@+ $@
0152
0153 $(MAN_HTML): $(OUTPUT)%.html: %.txt
0154         $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \
0155         $(ASCIIDOC_EXTRA) -aperf_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
0156         mv $@+ $@