316 lines · plain
1# SPDX-License-Identifier: GPL-2.0-only2include ../../scripts/Makefile.include3include ../../scripts/utilities.mak4 5ARTICLES =6# with their own formatting rules.7SP_ARTICLES =8 9MAN1_TXT= \10 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \11 $(wildcard perf-*.txt)) \12 perf.txt13MAN5_TXT=14MAN7_TXT=15 16MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)17_MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))18_MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))19 20MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))21MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))22 23_DOC_HTML = $(_MAN_HTML)24_DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))25DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML))26 27_DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))28_DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))29_DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))30 31DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1))32DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5))33DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7))34 35# Make the path relative to DESTDIR, not prefix36ifndef DESTDIR37prefix?=$(HOME)38endif39bindir?=$(prefix)/bin40htmldir?=$(prefix)/share/doc/perf-doc41pdfdir?=$(prefix)/share/doc/perf-doc42mandir?=$(prefix)/share/man43man1dir=$(mandir)/man144man5dir=$(mandir)/man545man7dir=$(mandir)/man746 47ASCIIDOC=asciidoc48ASCIIDOC_EXTRA += --unsafe -f asciidoc.conf49ASCIIDOC_HTML = xhtml1150MANPAGE_XSL = manpage-normal.xsl51XMLTO_EXTRA =52INSTALL?=install53RM ?= rm -f54DOC_REF = origin/man55HTML_REF = origin/html56 57ifdef USE_ASCIIDOCTOR58ASCIIDOC = asciidoctor59ASCIIDOC_EXTRA += -a compat-mode60ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions61ASCIIDOC_EXTRA += -a mansource="perf" -a manmanual="perf Manual"62ASCIIDOC_HTML = xhtml563endif64 65infodir?=$(prefix)/share/info66MAKEINFO=makeinfo67INSTALL_INFO=install-info68DOCBOOK2X_TEXI=docbook2x-texi69DBLATEX=dblatex70XMLTO=xmlto71ifndef PERL_PATH72 PERL_PATH = /usr/bin/perl73endif74 75-include ../config.mak.autogen76-include ../config.mak77 78_tmp_tool_path := $(call get-executable,$(ASCIIDOC))79ifeq ($(_tmp_tool_path),)80 missing_tools = $(ASCIIDOC)81endif82 83ifndef USE_ASCIIDOCTOR84_tmp_tool_path := $(call get-executable,$(XMLTO))85ifeq ($(_tmp_tool_path),)86 missing_tools += $(XMLTO)87endif88endif89 90#91# For asciidoc ...92# -7.1.2, no extra settings are needed.93# 8.0-, set ASCIIDOC8.94#95 96#97# For docbook-xsl ...98# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)99# 1.69.0, no extra settings are needed?100# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?101# 1.71.1, no extra settings are needed?102# 1.72.0, set DOCBOOK_XSL_172.103# 1.73.0-, set ASCIIDOC_NO_ROFF104#105 106#107# If you had been using DOCBOOK_XSL_172 in an attempt to get rid108# of 'the ".ft C" problem' in your generated manpages, and you109# instead ended up with weird characters around callouts, try110# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).111#112 113ifdef ASCIIDOC8114ASCIIDOC_EXTRA += -a asciidoc7compatible115endif116ifdef DOCBOOK_XSL_172117ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff118MANPAGE_XSL = manpage-1.72.xsl119else120 ifdef ASCIIDOC_NO_ROFF121 # docbook-xsl after 1.72 needs the regular XSL, but will not122 # pass-thru raw roff codes from asciidoc.conf, so turn them off.123 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff124 endif125endif126ifdef MAN_BOLD_LITERAL127XMLTO_EXTRA += -m manpage-bold-literal.xsl128endif129ifdef DOCBOOK_SUPPRESS_SP130XMLTO_EXTRA += -m manpage-suppress-sp.xsl131endif132 133SHELL_PATH ?= $(SHELL)134# Shell quote;135SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))136 137#138# Please note that there is a minor bug in asciidoc.139# The version after 6.0.3 _will_ include the patch found here:140# http://marc.theaimsgroup.com/?l=perf&m=111558757202243&w=2141#142# Until that version is released you may have to apply the patch143# yourself - yes, all 6 characters of it!144#145 146QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir147QUIET_SUBDIR1 =148 149ifneq ($(findstring $(MAKEFLAGS),w),w)150PRINT_DIR = --no-print-directory151else # "make -w"152NO_SUBDIR = :153endif154 155ifneq ($(findstring $(MAKEFLAGS),s),s)156ifneq ($(V),1)157 QUIET_ASCIIDOC = @echo ' ASCIIDOC '$@;158 QUIET_XMLTO = @echo ' XMLTO '$@;159 QUIET_DB2TEXI = @echo ' DB2TEXI '$@;160 QUIET_MAKEINFO = @echo ' MAKEINFO '$@;161 QUIET_DBLATEX = @echo ' DBLATEX '$@;162 QUIET_XSLTPROC = @echo ' XSLTPROC '$@;163 QUIET_GEN = @echo ' GEN '$@;164 QUIET_STDERR = 2> /dev/null165 QUIET_SUBDIR0 = +@subdir=166 QUIET_SUBDIR1 = ;$(NO_SUBDIR) \167 echo ' SUBDIR ' $$subdir; \168 $(MAKE) $(PRINT_DIR) -C $$subdir169 export V170endif171endif172 173all: html man info174 175html: $(DOC_HTML)176 177$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf178 179man: man1 man5 man7180man1: $(DOC_MAN1)181man5: $(DOC_MAN5)182man7: $(DOC_MAN7)183 184info: $(OUTPUT)perf.info $(OUTPUT)perfman.info185 186install: install-man187 188check-man-tools:189ifdef missing_tools190 $(error "You need to install $(missing_tools) for man pages")191endif192 193do-install-man: man194 $(call QUIET_INSTALL, Documentation-man) \195 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir); \196# $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir); \197# $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir); \198 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir); \199# $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir); \200# $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)201 202install-man: check-man-tools man do-install-man203 204ifdef missing_tools205 DO_INSTALL_MAN = $(warning Please install $(missing_tools) to have the man pages installed)206else207 DO_INSTALL_MAN = do-install-man208endif209 210try-install-man: $(DO_INSTALL_MAN)211 212install-info: info213 $(call QUIET_INSTALL, Documentation-info) \214 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir); \215 $(INSTALL) -m 644 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(DESTDIR)$(infodir); \216 if test -r $(DESTDIR)$(infodir)/dir; then \217 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\218 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\219 else \220 echo "No directory found in $(DESTDIR)$(infodir)" >&2 ; \221 fi222 223#install-html: html224# '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)225 226 227#228# Determine "include::" file references in asciidoc files.229#230$(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl231 $(QUIET_GEN)$(RM) $@+ $@ && \232 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \233 mv $@+ $@234 235-include $(OUTPUT)doc.dep236 237CLEAN_FILES = \238 $(MAN_XML) $(addsuffix +,$(MAN_XML)) \239 $(MAN_HTML) $(addsuffix +,$(MAN_HTML)) \240 $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7) \241 $(OUTPUT)*.texi $(OUTPUT)*.texi+ $(OUTPUT)*.texi++ \242 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(OUTPUT)doc.dep \243 $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt244clean:245 $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES)246 247$(MAN_HTML): $(OUTPUT)%.html : %.txt248 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \249 $(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \250 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \251 mv $@+ $@252 253# Generate date from either KBUILD_BUILD_TIMESTAMP or git log of254# the doc input file255PERF_DATE = $(strip \256 $(if $(KBUILD_BUILD_TIMESTAMP), \257 $(shell date -u -d '$(KBUILD_BUILD_TIMESTAMP)' +%Y-%m-%d), \258 $(shell git log -1 --pretty="format:%cd" \259 --date=short --no-show-signature $<)))260 261ifdef USE_ASCIIDOCTOR262$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : %.txt263 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \264 $(ASCIIDOC) -b manpage -d manpage \265 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) \266 -adocdate=$(PERF_DATE) -o $@+ $< && \267 mv $@+ $@268endif269 270$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml271 $(QUIET_XMLTO)$(RM) $@ && \272 $(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<273 274$(OUTPUT)%.xml : %.txt275 $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \276 $(ASCIIDOC) -b docbook -d manpage \277 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) \278 -aperf_date=$(PERF_DATE) -o $@+ $< && \279 mv $@+ $@280 281XSLT = docbook.xsl282XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css283 284$(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl285 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \286 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \287 --to-stdout $(xml) &&) true) > $@++ && \288 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \289 rm $@++ && \290 mv $@+ $@291 292$(OUTPUT)perfman.info: $(OUTPUT)perfman.texi293 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate -o $@ $*.texi294 295$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml296 $(QUIET_DB2TEXI)$(RM) $@+ $@ && \297 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \298 mv $@+ $@299 300$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt301 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $*.txt302 303WEBDOC_DEST = /pub/software/tools/perf/docs304 305# UNIMPLEMENTED306#install-webdoc : html307# '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)308 309# quick-install: quick-install-man310 311# quick-install-man:312# '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)313 314#quick-install-html:315# '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)316