9ecc71289ae53329f20fdceb24d5ed58e3205207
[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 lttng-destroy \
14 lttng-set-session \
15 lttng-save \
16 lttng-load \
17 lttng-start \
18 lttng-stop \
19 lttng-version \
20 lttng-view \
21 lttng-enable-channel \
22 lttng-disable-channel \
23 lttng-add-context
24 MAN3_NAMES =
25 MAN8_NAMES =
26 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
27 MAN3_NO_ASCIIDOC_NAMES =
28 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
29
30 # man pages destinations
31 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
32 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
33 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
34 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
35 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
36 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
37 MAN = $(MAN1) $(MAN3) $(MAN8)
38
39 # those are always installed since they are written in troff
40 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
41 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
42 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
43
44 # only build man pages if it was enabled
45 if BUILD_MAN_PAGES
46 # dist + install
47 dist_man1_MANS += $(MAN1)
48 dist_man3_MANS += $(MAN3)
49 dist_man8_MANS += $(MAN8)
50
51 # AsciiDoc sources and outputs
52 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
53 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
54 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
55 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
56 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
57
58 # common AsciiDoc source files
59 COMMON_TXT = \
60 $(srcdir)/common-footer.txt \
61 $(srcdir)/common-cmd-footer.txt \
62 $(srcdir)/common-cmd-options-head.txt \
63 $(srcdir)/common-cmd-help-options.txt
64
65 # config
66 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
67 XSL_FILES = \
68 manpage.xsl \
69 manpage-base.xsl \
70 manpage-bold-literal.xsl \
71 manpage-ulinks.xsl
72 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
73
74 # common dependencies
75 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
76
77 # tools
78 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
79 -a lttng_version=$(PACKAGE_VERSION)
80 ADOC_DOCBOOK = $(ADOC) -b docbook
81 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
82
83 # recipes
84 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
85 $(ADOC_DOCBOOK) -o $@ $<
86
87 %.1: %.1.xml $(XSL_SRC_FILES)
88 $(XTO) $<
89
90 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
91 $(ADOC_DOCBOOK) -o $@ $<
92
93 %.3: %.3.xml $(XSL_SRC_FILES)
94 $(XTO) $<
95
96 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
97 $(ADOC_DOCBOOK) -o $@ $<
98
99 %.8: %.8.xml $(XSL_SRC_FILES)
100 $(XTO) $<
101
102 clean-local:
103 rm -rf $(MAN_XML)
104 rm -rf $(MAN)
105 else
106 if IN_GIT_REPO
107 # we are in the Git repo: the man pages should be built for distribution
108 dist-hook:
109 @echo
110 @echo 'Error: Please build the man pages before creating a tarball.'
111 @echo
112 @false
113 else
114 # we are in the tarball, hence the man pages are already built
115 dist_man1_MANS += $(MAN1)
116 dist_man3_MANS += $(MAN3)
117 dist_man8_MANS += $(MAN8)
118 endif # IN_GIT_REPO
119 endif # BUILD_MAN_PAGES
This page took 0.044649 seconds and 3 git commands to generate.