^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) include ../../../scripts/Makefile.include
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) include ../../../scripts/utilities.mak
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) # This Makefile and manpage XSL files were taken from tools/perf/Documentation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) # and modified for libtraceevent.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) MAN3_TXT= \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) $(wildcard libtraceevent-*.txt) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) libtraceevent.txt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) MAN_TXT = $(MAN3_TXT)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) _MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) _MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) _DOC_MAN3=$(patsubst %.txt,%.3,$(MAN3_TXT))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) DOC_MAN3=$(addprefix $(OUTPUT),$(_DOC_MAN3))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) # Make the path relative to DESTDIR, not prefix
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) ifndef DESTDIR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) prefix?=$(HOME)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) bindir?=$(prefix)/bin
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) htmldir?=$(prefix)/share/doc/libtraceevent-doc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) pdfdir?=$(prefix)/share/doc/libtraceevent-doc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) mandir?=$(prefix)/share/man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) man3dir=$(mandir)/man3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) ASCIIDOC=asciidoc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) ASCIIDOC_EXTRA = --unsafe -f asciidoc.conf
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) ASCIIDOC_HTML = xhtml11
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) MANPAGE_XSL = manpage-normal.xsl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) XMLTO_EXTRA =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) INSTALL?=install
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) RM ?= rm -f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) ifdef USE_ASCIIDOCTOR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) ASCIIDOC = asciidoctor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) ASCIIDOC_EXTRA = -a compat-mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) ASCIIDOC_EXTRA += -a mansource="libtraceevent" -a manmanual="libtraceevent Manual"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) ASCIIDOC_HTML = xhtml5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) XMLTO=xmlto
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) _tmp_tool_path := $(call get-executable,$(ASCIIDOC))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) ifeq ($(_tmp_tool_path),)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) missing_tools = $(ASCIIDOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) ifndef USE_ASCIIDOCTOR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) _tmp_tool_path := $(call get-executable,$(XMLTO))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) ifeq ($(_tmp_tool_path),)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) missing_tools += $(XMLTO)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) # For asciidoc ...
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) # -7.1.2, no extra settings are needed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) # 8.0-, set ASCIIDOC8.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) # For docbook-xsl ...
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) # -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) # 1.69.0, no extra settings are needed?
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) # 1.71.1, no extra settings are needed?
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) # 1.72.0, set DOCBOOK_XSL_172.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) # 1.73.0-, set ASCIIDOC_NO_ROFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) # If you had been using DOCBOOK_XSL_172 in an attempt to get rid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) # of 'the ".ft C" problem' in your generated manpages, and you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) # instead ended up with weird characters around callouts, try
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) # using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) ifdef ASCIIDOC8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) ASCIIDOC_EXTRA += -a asciidoc7compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) ifdef DOCBOOK_XSL_172
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) ASCIIDOC_EXTRA += -a libtraceevent-asciidoc-no-roff
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) MANPAGE_XSL = manpage-1.72.xsl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) ifdef ASCIIDOC_NO_ROFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) # docbook-xsl after 1.72 needs the regular XSL, but will not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) # pass-thru raw roff codes from asciidoc.conf, so turn them off.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) ASCIIDOC_EXTRA += -a libtraceevent-asciidoc-no-roff
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) ifdef MAN_BOLD_LITERAL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) XMLTO_EXTRA += -m manpage-bold-literal.xsl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) ifdef DOCBOOK_SUPPRESS_SP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) XMLTO_EXTRA += -m manpage-suppress-sp.xsl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) SHELL_PATH ?= $(SHELL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) # Shell quote;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) DESTDIR ?=
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) DESTDIR_SQ = '$(subst ','\'',$(DESTDIR))'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) export DESTDIR DESTDIR_SQ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) # Please note that there is a minor bug in asciidoc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) # The version after 6.0.3 _will_ include the patch found here:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) # http://marc.theaimsgroup.com/?l=libtraceevent&m=111558757202243&w=2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) # Until that version is released you may have to apply the patch
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) # yourself - yes, all 6 characters of it!
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) QUIET_SUBDIR1 =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) ifneq ($(findstring $(MAKEFLAGS),w),w)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) PRINT_DIR = --no-print-directory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) else # "make -w"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) NO_SUBDIR = :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) ifneq ($(findstring $(MAKEFLAGS),s),s)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) ifneq ($(V),1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) QUIET_ASCIIDOC = @echo ' ASCIIDOC '$@;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) QUIET_XMLTO = @echo ' XMLTO '$@;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) QUIET_SUBDIR0 = +@subdir=
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) QUIET_SUBDIR1 = ;$(NO_SUBDIR) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) echo ' SUBDIR ' $$subdir; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) $(MAKE) $(PRINT_DIR) -C $$subdir
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) export V
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) all: html man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) man: man3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) man3: $(DOC_MAN3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) html: $(MAN_HTML)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) $(MAN_HTML) $(DOC_MAN3): asciidoc.conf
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) install: install-man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) check-man-tools:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) ifdef missing_tools
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) $(error "You need to install $(missing_tools) for man pages")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) do-install-man: man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) $(call QUIET_INSTALL, Documentation-man) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) $(INSTALL) -d -m 755 $(DESTDIR)$(man3dir); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) $(INSTALL) -m 644 $(DOC_MAN3) $(DESTDIR)$(man3dir);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) install-man: check-man-tools man do-install-man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) uninstall: uninstall-man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) uninstall-man:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) $(call QUIET_UNINST, Documentation-man) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) $(Q)$(RM) $(addprefix $(DESTDIR)$(man3dir)/,$(DOC_MAN3))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) ifdef missing_tools
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) DO_INSTALL_MAN = $(warning Please install $(missing_tools) to have the man pages installed)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) DO_INSTALL_MAN = do-install-man
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) CLEAN_FILES = \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) $(MAN_XML) $(addsuffix +,$(MAN_XML)) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) $(MAN_HTML) $(addsuffix +,$(MAN_HTML)) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) $(DOC_MAN3) *.3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) clean:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) ifdef USE_ASCIIDOCTOR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) $(OUTPUT)%.3 : $(OUTPUT)%.txt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) $(ASCIIDOC) -b manpage -d manpage \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) $(ASCIIDOC_EXTRA) -alibtraceevent_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) mv $@+ $@
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) $(OUTPUT)%.3 : $(OUTPUT)%.xml
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) $(QUIET_XMLTO)$(RM) $@ && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) $(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) $(OUTPUT)%.xml : %.txt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) $(ASCIIDOC) -b docbook -d manpage \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) $(ASCIIDOC_EXTRA) -alibtraceevent_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) mv $@+ $@
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) $(MAN_HTML): $(OUTPUT)%.html : %.txt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) $(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) $(ASCIIDOC_EXTRA) -aperf_version=$(EVENT_PARSE_VERSION) -o $@+ $< && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) mv $@+ $@