X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=doc%2Fman%2FMakefile.am;h=9cee98d13d163aa69bca82d74fc96f8f29982607;hb=31624f6cf986d7e7761847f66562c97bc773a02c;hp=22aed15498cd7a6d3d4ced1a4febb2f88c483aa9;hpb=2b4444ce6a9fa02ae46a67085c17aef55dc85941;p=lttng-ust.git diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 22aed154..9cee98d1 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,3 +1,5 @@ +# SPDX-License-Identifier: LGPL-2.1-only + # Man pages are only built if they are enabled at configure time. # # They should always be built before creating a distribution tarball. @@ -15,6 +17,9 @@ MAN3_NAMES = \ lttng-ust-dl \ lttng-ust-cyg-profile +# Man page aliases (generated from other sources): +MAN3_ALIASES = vtracef.3 vtracelog.3 + # troff man pages: MAN3_TROFF = do_tracepoint.3 tracepoint.3 tracepoint_enabled.3 @@ -34,44 +39,56 @@ COMMON_TXT = \ # AsciiDoc configuration and XSL files: ASCIIDOC_CONF = $(srcdir)/asciidoc.conf -XSL_FILES = \ - manpage.xsl \ - manpage-callouts.xsl \ - manpage-bold-literal.xsl \ - manpage-links.xsl \ - manpage-headings.xsl -XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES)) +XSL_FILE = $(srcdir)/manpage.xsl # Common dependencies: COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT) # Man pages destinations: MAN1 = $(addsuffix .1,$(MAN1_NAMES)) -MAN3 = $(addsuffix .3,$(MAN3_NAMES)) +MAN3 = $(addsuffix .3,$(MAN3_NAMES)) $(MAN3_ALIASES) MAN = $(MAN1) $(MAN3) if MAN_PAGES_OPT # At this point, we know the user asked to build the man pages. if HAVE_ASCIIDOC_XMLTO + +asciidoc_verbose = $(asciidoc_verbose_@AM_V@) +asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@) +asciidoc_verbose_0 = @echo " ASCIIDOC " $@; + +xmlto_verbose = $(xmlto_verbose_@AM_V@) +xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@) +xmlto_verbose_0 = @echo " XMLTO " $@; + # Tools to execute: -ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \ - -a lttng_version="$(PACKAGE_VERSION)" \ - -a lttng_ust_register_timeout="@LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS@" +ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \ + -a lttng_ust_register_timeout="@LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS@" \ + -a mansource="LTTng" \ + -a manmanual="LTTng Manual" \ + -a manversion="$(PACKAGE_VERSION)" + ADOC_DOCBOOK = $(ADOC) -b docbook -XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man +XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man # Recipes: %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< -%.1: %.1.xml $(XSL_SRC_FILES) - $(XTO) $< +%.1: %.1.xml $(XSL_FILE) + $(XTO) $< 2>/dev/null %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< -%.3: %.3.xml $(XSL_SRC_FILES) - $(XTO) $< +tracef.3 vtracef.3 &: tracef.3.xml $(XSL_FILE) + $(XTO) $< 2>/dev/null + +tracelog.3 vtracelog.3 &: tracelog.3.xml $(XSL_FILE) + $(XTO) $< 2>/dev/null + +%.3: %.3.xml $(XSL_FILE) + $(XTO) $< 2>/dev/null # Only clean the generated files if we have the tools to generate them again. CLEANFILES = $(MAN_XML) $(MAN) @@ -113,4 +130,4 @@ dist-hook: endif # !MAN_PAGES_OPT # Always distribute the source files. -EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) $(ASCIIDOC_CONF) +EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) $(ASCIIDOC_CONF) README.md