Commit | Line | Data |
---|---|---|
6f6794a6 | 1 | # Man pages are only built if they are enabled at configure time. |
ceb84f55 PP |
2 | # |
3 | # They should always be built before creating a distribution tarball. | |
4 | ||
5 | # function which adds the source directory prefix and adds a given suffix | |
6 | manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2))) | |
7 | ||
8 | # List only the names without the .*.txt extension here: | |
9 | MAN1_NAMES = \ | |
ba50d967 | 10 | lttng \ |
7bf169bd | 11 | lttng-create \ |
9d4408b8 | 12 | lttng-destroy \ |
b3903b3a | 13 | lttng-set-session \ |
44f5039e | 14 | lttng-save \ |
30ec772c | 15 | lttng-load \ |
fb58d659 | 16 | lttng-start \ |
e85eccc8 | 17 | lttng-stop \ |
79e094df | 18 | lttng-version \ |
b4867b3b | 19 | lttng-view \ |
4bf0a332 | 20 | lttng-enable-channel \ |
2e4886b8 | 21 | lttng-disable-channel \ |
882108c6 | 22 | lttng-add-context \ |
89dbeff8 | 23 | lttng-list \ |
65226554 | 24 | lttng-calibrate \ |
882443a6 | 25 | lttng-track \ |
18d6fa61 | 26 | lttng-untrack \ |
afaad15a | 27 | lttng-status \ |
12397c59 | 28 | lttng-help \ |
e9b06e2b | 29 | lttng-snapshot \ |
290294e8 | 30 | lttng-enable-event \ |
aec4668a | 31 | lttng-disable-event \ |
11533074 | 32 | lttng-crash \ |
eded6438 JD |
33 | lttng-metadata \ |
34 | lttng-regenerate | |
ceb84f55 | 35 | MAN3_NAMES = |
f5595c32 | 36 | MAN8_NAMES = lttng-sessiond lttng-relayd |
aec4668a | 37 | MAN1_NO_ASCIIDOC_NAMES = |
23225252 | 38 | MAN3_NO_ASCIIDOC_NAMES = lttng-health-check |
f5595c32 | 39 | MAN8_NO_ASCIIDOC_NAMES = |
ceb84f55 | 40 | |
ceb84f55 PP |
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 \ | |
83f27f71 | 51 | $(srcdir)/common-cmd-footer.txt \ |
ba50d967 PP |
52 | $(srcdir)/common-cmd-options-head.txt \ |
53 | $(srcdir)/common-cmd-help-options.txt | |
ceb84f55 PP |
54 | |
55 | # config | |
767ab8b2 | 56 | ASCIIDOC_CONF = $(srcdir)/asciidoc.conf |
c4ee4984 | 57 | ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf |
ceb84f55 PP |
58 | XSL_FILES = \ |
59 | manpage.xsl \ | |
41af7458 | 60 | manpage-callouts.xsl \ |
ceb84f55 | 61 | manpage-bold-literal.xsl \ |
4d7f0487 | 62 | manpage-links.xsl |
ceb84f55 PP |
63 | XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES)) |
64 | ||
65 | # common dependencies | |
66 | COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT) | |
67 | ||
a3eae3c9 PP |
68 | # man pages destinations |
69 | MAN1 = $(addsuffix .1,$(MAN1_NAMES)) | |
70 | MAN3 = $(addsuffix .3,$(MAN3_NAMES)) | |
71 | MAN8 = $(addsuffix .8,$(MAN8_NAMES)) | |
72 | MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES)) | |
73 | MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES)) | |
74 | MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES)) | |
75 | MAN = $(MAN1) $(MAN3) $(MAN8) | |
76 | ||
77 | if MAN_PAGES_OPT | |
78 | # at this point, we know the user asked to build the man pages | |
79 | if HAVE_ASCIIDOC_XMLTO | |
ceb84f55 | 80 | # tools |
c4ee4984 | 81 | ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage |
ceb84f55 PP |
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 | ||
a3eae3c9 PP |
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) | |
ceb84f55 | 122 | @false |
a3eae3c9 PP |
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 | |
ceb84f55 PP |
133 | dist_man1_MANS += $(MAN1) |
134 | dist_man3_MANS += $(MAN3) | |
135 | dist_man8_MANS += $(MAN8) | |
a3eae3c9 PP |
136 | endif # MAN_PAGES_OPT |
137 | ||
2f1c0906 PP |
138 | if !MAN_PAGES_OPT |
139 | dist-hook: | |
140 | @echo "Error: Please enable the man pages before creating a distribution tarball." | |
141 | @false | |
142 | endif # !MAN_PAGES_OPT | |
143 | ||
a3eae3c9 | 144 | # always distribute the source files |
c4ee4984 PP |
145 | EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \ |
146 | $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in |