X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2FMakefile.am;h=d84bfcdc91b05799e2a029df5f33159bcd70e3c1;hb=156b0cf7b48f8f2e0e99b148803354ba8b1e5c6a;hp=fcc4c5c731558e80a5c141fe1ba02827aa5402c4;hpb=6bf962a42535935d8c4c8811b9482f90c5b98212;p=lttng-ust.git diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index fcc4c5c7..d84bfcdc 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 @@ -41,32 +46,48 @@ 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 mansource="LTTng" \ + -a manmanual="LTTng Manual" \ + -a manversion="$(PACKAGE_VERSION)" ADOC_DOCBOOK = $(ADOC) -b docbook -XTO = $(XMLTO) -m $(XSL_FILE) man +XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man # Recipes: %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< %.1: %.1.xml $(XSL_FILE) - $(XTO) $< + $(XTO) $< 2>/dev/null %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< +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) $< + $(XTO) $< 2>/dev/null # Only clean the generated files if we have the tools to generate them again. CLEANFILES = $(MAN_XML) $(MAN) @@ -108,4 +129,4 @@ dist-hook: endif # !MAN_PAGES_OPT # Always distribute the source files. -EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) $(ASCIIDOC_CONF) +EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) $(ASCIIDOC_CONF) README.md