Lines Matching +full:technical +full:- +full:documentation
1 # SPDX-License-Identifier: GPL-2.0-only
6 $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \
7 $(wildcard perf-*.txt)) \
22 …DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wil…
24 SP_ARTICLES += technical/api-index
43 htmldir?=$(prefix)/share/doc/perf-doc
44 pdfdir?=$(prefix)/share/doc/perf-doc
51 ASCIIDOC_EXTRA += --unsafe -f asciidoc.conf
53 MANPAGE_XSL = manpage-normal.xsl
56 RM ?= rm -f
62 ASCIIDOC_EXTRA += -a compat-mode
63 ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
64 ASCIIDOC_EXTRA += -a mansource="perf" -a manmanual="perf Manual"
70 INSTALL_INFO=install-info
71 DOCBOOK2X_TEXI=docbook2x-texi
78 -include ../config.mak.autogen
79 -include ../config.mak
81 _tmp_tool_path := $(call get-executable,$(ASCIIDOC))
87 _tmp_tool_path := $(call get-executable,$(XMLTO))
95 # -7.1.2, no extra settings are needed.
96 # 8.0-, set ASCIIDOC8.
100 # For docbook-xsl ...
101 # -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
103 # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
106 # 1.73.0-, set ASCIIDOC_NO_ROFF
117 ASCIIDOC_EXTRA += -a asciidoc7compatible
120 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
121 MANPAGE_XSL = manpage-1.72.xsl
124 # docbook-xsl after 1.72 needs the regular XSL, but will not
125 # pass-thru raw roff codes from asciidoc.conf, so turn them off.
126 ASCIIDOC_EXTRA += -a perf-asciidoc-no-roff
130 XMLTO_EXTRA += -m manpage-bold-literal.xsl
133 XMLTO_EXTRA += -m manpage-suppress-sp.xsl
146 # yourself - yes, all 6 characters of it!
149 QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir
153 PRINT_DIR = --no-print-directory
154 else # "make -w"
171 $(MAKE) $(PRINT_DIR) -C $$subdir
189 pdf: $(OUTPUT)user-manual.pdf
191 install: install-man
193 check-man-tools:
198 do-install-man: man
199 $(call QUIET_INSTALL, Documentation-man) \
200 $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir); \
201 # $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir); \
202 # $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir); \
203 $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(man1dir); \
204 # $(INSTALL) -m 644 $(DOC_MAN5) $(DESTDIR)$(man5dir); \
205 # $(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)
207 install-man: check-man-tools man do-install-man
212 DO_INSTALL_MAN = do-install-man
215 try-install-man: $(DO_INSTALL_MAN)
217 install-info: info
218 $(call QUIET_INSTALL, Documentation-info) \
219 $(INSTALL) -d -m 755 $(DESTDIR)$(infodir); \
220 $(INSTALL) -m 644 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(DESTDIR)$(infodir); \
221 if test -r $(DESTDIR)$(infodir)/dir; then \
222 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\
223 $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\
228 install-pdf: pdf
229 $(call QUIET_INSTALL, Documentation-pdf) \
230 $(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir); \
231 $(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir)
233 #install-html: html
234 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
240 $(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl
242 $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
245 -include $(OUTPUT)doc.dep
247 _cmds_txt = cmds-ancillaryinterrogators.txt \
248 cmds-ancillarymanipulators.txt \
249 cmds-mainporcelain.txt \
250 cmds-plumbinginterrogators.txt \
251 cmds-plumbingmanipulators.txt \
252 cmds-synchingrepositories.txt \
253 cmds-synchelpers.txt \
254 cmds-purehelpers.txt \
255 cmds-foreignscminterface.txt
258 $(cmds_txt): $(OUTPUT)cmd-list.made
260 $(OUTPUT)cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
262 $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
271 $(OUTPUT)howto-index.txt $(OUTPUT)howto/*.html $(OUTPUT)doc.dep \
272 $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt \
275 $(call QUIET_CLEAN, Documentation) $(RM) $(CLEAN_FILES)
279 $(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \
280 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
286 $(ASCIIDOC) -b manpage -d manpage \
287 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
293 $(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
297 $(ASCIIDOC) -b docbook -d manpage \
298 $(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) \
299 -aperf_date=$(shell git log -1 --pretty="format:%cd" \
300 --date=short $<) \
301 -o $@+ $< && \
305 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
307 $(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml
308 $(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
310 $(OUTPUT)perf.info: $(OUTPUT)user-manual.texi
311 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi
313 $(OUTPUT)user-manual.texi: $(OUTPUT)user-manual.xml
315 $(DOCBOOK2X_TEXI) $(OUTPUT)user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
316 $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
320 $(OUTPUT)user-manual.pdf: $(OUTPUT)user-manual.xml
322 …$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-…
325 $(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl
327 ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \
328 --to-stdout $(xml) &&) true) > $@++ && \
329 $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
334 $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
338 $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
341 howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
343 '$(SHELL_PATH_SQ)' ./howto-index.sh $(wildcard howto/*.txt) >$@+ && \
347 $(QUIET_ASCIIDOC)$(ASCIIDOC) -b $(ASCIIDOC_HTML) $*.txt
353 sed -e '1,/^$$/d' $< | $(ASCIIDOC) -b $(ASCIIDOC_HTML) - >$@+ && \
357 #install-webdoc : html
358 # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
360 # quick-install: quick-install-man
362 # quick-install-man:
363 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir)
365 #quick-install-html:
366 # '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(HTML_REF) $(DESTDIR)$(htmldir)