Fix: standardize man pages building/installing
[lttng-tools.git] / doc / man / Makefile.am
1 # Man pages are only built if the --enable-man-pages option was
2 # passed 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 lttng-status \
29 lttng-help \
30 lttng-snapshot \
31 lttng-enable-event \
32 lttng-disable-event \
33 lttng-crash \
34 lttng-metadata
35 MAN3_NAMES =
36 MAN8_NAMES = lttng-sessiond lttng-relayd
37 MAN1_NO_ASCIIDOC_NAMES =
38 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
39 MAN8_NO_ASCIIDOC_NAMES =
40
41 # AsciiDoc sources and outputs
42 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
43 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
44 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
45 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
46 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
47
48 # common AsciiDoc source files
49 COMMON_TXT = \
50 $(srcdir)/common-footer.txt \
51 $(srcdir)/common-cmd-footer.txt \
52 $(srcdir)/common-cmd-options-head.txt \
53 $(srcdir)/common-cmd-help-options.txt
54
55 # config
56 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
57 XSL_FILES = \
58 manpage.xsl \
59 manpage-callouts.xsl \
60 manpage-bold-literal.xsl \
61 manpage-links.xsl
62 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
63
64 # common dependencies
65 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
66
67 # man pages destinations
68 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
69 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
70 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
71 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
72 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
73 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
74 MAN = $(MAN1) $(MAN3) $(MAN8)
75
76 if MAN_PAGES_OPT
77 # at this point, we know the user asked to build the man pages
78 if HAVE_ASCIIDOC_XMLTO
79 # tools
80 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
81 -a lttng_version="$(PACKAGE_VERSION)"
82 ADOC_DOCBOOK = $(ADOC) -b docbook
83 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
84
85 # recipes
86 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
87 $(ADOC_DOCBOOK) -o $@ $<
88
89 %.1: %.1.xml $(XSL_SRC_FILES)
90 $(XTO) $<
91
92 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
93 $(ADOC_DOCBOOK) -o $@ $<
94
95 %.3: %.3.xml $(XSL_SRC_FILES)
96 $(XTO) $<
97
98 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
99 $(ADOC_DOCBOOK) -o $@ $<
100
101 %.8: %.8.xml $(XSL_SRC_FILES)
102 $(XTO) $<
103
104 # only clean the generated files if we have the tools to generate them again
105 CLEANFILES = $(MAN_XML) $(MAN)
106 else # HAVE_ASCIIDOC_XMLTO
107 # create man page targets used to stop the build if we want to
108 # build the man pages, but we don't have the necessary tools to do so
109 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
110 ERR_MSG += "Make sure both tools are installed and run the configure script again."
111
112 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
113 @echo $(ERR_MSG)
114 @false
115
116 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
117 @echo $(ERR_MSG)
118 @false
119
120 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
121 @echo $(ERR_MSG)
122 @false
123 endif # HAVE_ASCIIDOC_XMLTO
124 endif # MAN_PAGES_OPT
125
126 # those are always installed since they are directly written in troff
127 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
128 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
129 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
130
131 if MAN_PAGES_OPT
132 # building man pages: we can install and distribute them
133 dist_man1_MANS += $(MAN1)
134 dist_man3_MANS += $(MAN3)
135 dist_man8_MANS += $(MAN8)
136 endif # MAN_PAGES_OPT
137
138 # always distribute the source files
139 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) $(ASCIIDOC_CONF)
This page took 0.033369 seconds and 5 git commands to generate.