X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2FMakefile.am;h=59c0ca08380af56cc2cf901390a1ec2a8e17bfe0;hp=845e475dd4e82c0c73fccc2927a76da7bd7ec756;hb=a942557f174ba5a1b71ae5334ee987643eca691c;hpb=fd3e1238cb0c3ad075e0f4f3c5f106145a0a6057 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 845e475dd..59c0ca083 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -1,3 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0-only + # Man pages are only built if they are enabled at configure time. # # They should always be built before creating a distribution tarball. @@ -30,7 +32,13 @@ MAN1_NAMES = \ lttng-disable-event \ lttng-crash \ lttng-metadata \ - lttng-regenerate + lttng-regenerate \ + lttng-rotate \ + lttng-enable-rotation \ + lttng-disable-rotation \ + lttng-clear \ + lttng-add-trigger + MAN3_NAMES = MAN8_NAMES = lttng-sessiond lttng-relayd MAN1_NO_ASCIIDOC_NAMES = @@ -54,12 +62,7 @@ COMMON_TXT = \ # config ASCIIDOC_CONF = $(srcdir)/asciidoc.conf ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf -XSL_FILES = \ - manpage.xsl \ - manpage-callouts.xsl \ - manpage-bold-literal.xsl \ - manpage-links.xsl -XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES)) +XSL_FILE = $(srcdir)/manpage.xsl # common dependencies COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT) @@ -73,13 +76,55 @@ MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES)) MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES)) MAN = $(MAN1) $(MAN3) $(MAN8) +# initially empty +CLEANFILES = + +if EMBED_HELP +mantoh_verbose = $(mantoh_verbose_@AM_V@) +mantoh_verbose_ = $(mantoh_verbose_@AM_DEFAULT_V@) +mantoh_verbose_0 = @echo " MANTOH " $@; + +MAN1_H = $(addsuffix .1.h,$(MAN1_NAMES)) +MAN3_H = $(addsuffix .3.h,$(MAN3_NAMES)) +MAN8_H = $(addsuffix .8.h,$(MAN8_NAMES)) +MAN_H = $(MAN1_H) $(MAN3_H) $(MAN8_H) +MAN_H_RECIPE = \ + $(mantoh_verbose_0)\ + MANWIDTH=80 @MANPROG@ --encoding=UTF-8 --no-hyphenation --no-justification --local-file $< > $@ ; \ + $(SED) -i 's/\\/\\\\/g' $@ ; \ + $(SED) -i 's/"/\\"/g' $@ ; \ + $(SED) -i 's/^\(.*\)$$/"\1\\n"/' $@ + +%.1.h: %.1 + $(MAN_H_RECIPE) + +%.3.h: %.3 + $(MAN_H_RECIPE) + +%.8.h: %.8 + $(MAN_H_RECIPE) + +all-local: $(MAN_H) + +CLEANFILES += $(MAN_H) +endif # EMBED_HELP + 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 -ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage +ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage ADOC_DOCBOOK = $(ADOC) -b docbook -XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man +XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man # only add this dependency if we can build the man pages because it's # a file generated by the configure script, so it's more recent than @@ -90,23 +135,23 @@ COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF) %.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) $< +%.3: %.3.xml $(XSL_FILE) + $(XTO) $< 2>/dev/null %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS) $(ADOC_DOCBOOK) -o $@ $< -%.8: %.8.xml $(XSL_SRC_FILES) - $(XTO) $< +%.8: %.8.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) +CLEANFILES += $(MAN_XML) $(MAN) else # HAVE_ASCIIDOC_XMLTO # create man page targets used to stop the build if we want to # build the man pages, but we don't have the necessary tools to do so @@ -146,5 +191,8 @@ dist-hook: endif # !MAN_PAGES_OPT # always distribute the source files -EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \ +EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) \ $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in + +# keep generated man pages that can be considered intermediate files +.PRECIOUS: %.1 %.3 %.8