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