doc/man: create lttng-create(1) and update/fix content
[lttng-tools.git] / doc / man / Makefile.am
1 # Man pages are only built if the --enable-build-man-pages option was passed
2 # to the configure script.
3 #
4 # They should always be built before creating a distribution tarball.
5
6 # function which adds the source directory prefix and adds a given suffix
7 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
8
9 # List only the names without the .*.txt extension here:
10 MAN1_NAMES = \
11 lttng \
12 lttng-create
13 MAN3_NAMES =
14 MAN8_NAMES =
15 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
16 MAN3_NO_ASCIIDOC_NAMES =
17 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
18
19 # man pages destinations
20 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
21 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
22 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
23 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
24 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
25 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
26 MAN = $(MAN1) $(MAN3) $(MAN8)
27
28 # those are always installed since they are written in troff
29 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
30 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
31 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
32
33 # only build man pages if it was enabled
34 if BUILD_MAN_PAGES
35 # dist + install
36 dist_man1_MANS += $(MAN1)
37 dist_man3_MANS += $(MAN3)
38 dist_man8_MANS += $(MAN8)
39
40 # AsciiDoc sources and outputs
41 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
42 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
43 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
44 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
45 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
46
47 # common AsciiDoc source files
48 COMMON_TXT = \
49 $(srcdir)/common-footer.txt \
50 $(srcdir)/common-cmd-footer.txt \
51 $(srcdir)/common-cmd-options-head.txt \
52 $(srcdir)/common-cmd-help-options.txt
53
54 # config
55 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
56 XSL_FILES = \
57 manpage.xsl \
58 manpage-base.xsl \
59 manpage-bold-literal.xsl \
60 manpage-ulinks.xsl
61 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
62
63 # common dependencies
64 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
65
66 # tools
67 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
68 -a lttng_version=$(PACKAGE_VERSION)
69 ADOC_DOCBOOK = $(ADOC) -b docbook
70 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
71
72 # recipes
73 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
74 $(ADOC_DOCBOOK) -o $@ $<
75
76 %.1: %.1.xml $(XSL_SRC_FILES)
77 $(XTO) $<
78
79 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
80 $(ADOC_DOCBOOK) -o $@ $<
81
82 %.3: %.3.xml $(XSL_SRC_FILES)
83 $(XTO) $<
84
85 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
86 $(ADOC_DOCBOOK) -o $@ $<
87
88 %.8: %.8.xml $(XSL_SRC_FILES)
89 $(XTO) $<
90
91 clean-local:
92 rm -rf $(MAN_XML)
93 rm -rf $(MAN)
94 else
95 if IN_GIT_REPO
96 # we are in the Git repo: the man pages should be built for distribution
97 dist-hook:
98 @echo
99 @echo 'Error: Please build the man pages before creating a tarball.'
100 @echo
101 @false
102 else
103 # we are in the tarball, hence the man pages are already built
104 dist_man1_MANS += $(MAN1)
105 dist_man3_MANS += $(MAN3)
106 dist_man8_MANS += $(MAN8)
107 endif # IN_GIT_REPO
108 endif # BUILD_MAN_PAGES
This page took 0.032894 seconds and 5 git commands to generate.