X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2FMakefile.am;h=8f20ede92e39f3bea3508e9ea8611e11aa450736;hb=HEAD;hp=eb88e86d8cc8f26d1fa81ce55c5fb970290c8bd2;hpb=360c4f63da21d6d5518a381aa78441d4b72da446;p=lttng-tools.git

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index eb88e86d8..8f20ede92 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.
@@ -5,6 +7,9 @@
 # function which adds the source directory prefix and adds a given suffix
 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
 
+# Local targets.
+LOCAL =
+
 # List only the names without the .*.txt extension here:
 MAN1_NAMES = \
 	lttng \
@@ -30,26 +35,39 @@ 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 \
+	lttng-remove-trigger \
+	lttng-list-triggers
 MAN3_NAMES =
+MAN7_NAMES = lttng-event-rule lttng-concepts
 MAN8_NAMES = lttng-sessiond lttng-relayd
 MAN1_NO_ASCIIDOC_NAMES =
 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
+MAN7_NO_ASCIIDOC_NAMES =
 MAN8_NO_ASCIIDOC_NAMES =
 
 # AsciiDoc sources and outputs
 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
+MAN7_TXT = $(call manaddsuffix,.7.txt,$(MAN7_NAMES))
 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
-MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
+MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN7_TXT) $(MAN8_TXT)
 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
 
 # common AsciiDoc source files
 COMMON_TXT = \
 	$(srcdir)/common-footer.txt \
-	$(srcdir)/common-cmd-footer.txt \
-	$(srcdir)/common-cmd-options-head.txt \
-	$(srcdir)/common-cmd-help-options.txt
+	$(srcdir)/common-lttng-cmd-after-options.txt \
+	$(srcdir)/common-lttng-cmd-options-head.txt \
+	$(srcdir)/common-lttng-cmd-help-options.txt \
+	$(srcdir)/common-help-option.txt \
+	$(srcdir)/common-intro.txt \
+	$(srcdir)/common-daemon-cfg.txt
 
 # config
 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
@@ -62,11 +80,13 @@ COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
 # man pages destinations
 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
+MAN7 = $(addsuffix .7,$(MAN7_NAMES))
 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
+MAN7_NO_ASCIIDOC = $(addsuffix .7,$(MAN7_NO_ASCIIDOC_NAMES))
 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
-MAN = $(MAN1) $(MAN3) $(MAN8)
+MAN = $(MAN1) $(MAN3) $(MAN7) $(MAN8)
 
 # initially empty
 CLEANFILES =
@@ -96,7 +116,7 @@ MAN_H_RECIPE = \
 %.8.h: %.8
 	$(MAN_H_RECIPE)
 
-all-local: $(MAN_H)
+LOCAL += $(MAN_H)
 
 CLEANFILES += $(MAN_H)
 endif # EMBED_HELP
@@ -136,6 +156,12 @@ COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
 %.3: %.3.xml $(XSL_FILE)
 	$(XTO) $< 2>/dev/null
 
+%.7.xml: $(srcdir)/%.7.txt $(COMMON_DEPS)
+	$(ADOC_DOCBOOK) -o $@ $<
+
+%.7: %.7.xml $(XSL_FILE)
+	$(XTO) $< 2>/dev/null
+
 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
 	$(ADOC_DOCBOOK) -o $@ $<
 
@@ -158,6 +184,10 @@ ERR_MSG += "Make sure both tools are installed and run the configure script agai
 	@echo $(ERR_MSG)
 	@false
 
+%.7: $(srcdir)/%.7.txt $(COMMON_DEPS)
+	@echo $(ERR_MSG)
+	@false
+
 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
 	@echo $(ERR_MSG)
 	@false
@@ -167,15 +197,38 @@ endif # MAN_PAGES_OPT
 # those are always installed since they are directly written in troff
 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
+dist_man7_MANS = $(MAN7_NO_ASCIIDOC)
 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
 
 if MAN_PAGES_OPT
 # building man pages: we can install and distribute them
 dist_man1_MANS += $(MAN1)
 dist_man3_MANS += $(MAN3)
+dist_man7_MANS += $(MAN7)
 dist_man8_MANS += $(MAN8)
 endif # MAN_PAGES_OPT
 
+MAN_HIERARCHY = man1 man3 man7 man8
+
+LOCAL += $(MAN_HIERARCHY)
+
+CLEANFILES += $(MAN_HIERARCHY)
+
+# Mimic mandb(8) path hierarchy -- as if installed -- by symlinking
+# sub-directories to the top man directory. This allows developers to read
+# the locally generated man pages. For example `$ ./pre-inst-env man lttng'.
+man1:
+	@ln -s $(abs_builddir) $@
+
+man3:
+	@ln -s $(abs_builddir) $@
+
+man7:
+	@ln -s $(abs_builddir) $@
+
+man8:
+	@ln -s $(abs_builddir) $@
+
 if !MAN_PAGES_OPT
 dist-hook:
 	@echo "Error: Please enable the man pages before creating a distribution tarball."
@@ -186,5 +239,8 @@ endif # !MAN_PAGES_OPT
 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) \
 	$(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
 
+# Build local targets.
+all-local: $(LOCAL)
+
 # keep generated man pages that can be considered intermediate files
-.PRECIOUS: %.1 %.3 %.8
+.PRECIOUS: %.1 %.3 %.7 %.8