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 \ |
882443a6 | 24 | lttng-track \ |
18d6fa61 | 25 | lttng-untrack \ |
afaad15a | 26 | lttng-status \ |
12397c59 | 27 | lttng-help \ |
e9b06e2b | 28 | lttng-snapshot \ |
290294e8 | 29 | lttng-enable-event \ |
aec4668a | 30 | lttng-disable-event \ |
11533074 | 31 | lttng-crash \ |
eded6438 JD |
32 | lttng-metadata \ |
33 | lttng-regenerate | |
ceb84f55 | 34 | MAN3_NAMES = |
f5595c32 | 35 | MAN8_NAMES = lttng-sessiond lttng-relayd |
aec4668a | 36 | MAN1_NO_ASCIIDOC_NAMES = |
23225252 | 37 | MAN3_NO_ASCIIDOC_NAMES = lttng-health-check |
f5595c32 | 38 | MAN8_NO_ASCIIDOC_NAMES = |
ceb84f55 | 39 | |
ceb84f55 PP |
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 \ | |
83f27f71 | 50 | $(srcdir)/common-cmd-footer.txt \ |
ba50d967 PP |
51 | $(srcdir)/common-cmd-options-head.txt \ |
52 | $(srcdir)/common-cmd-help-options.txt | |
ceb84f55 PP |
53 | |
54 | # config | |
767ab8b2 | 55 | ASCIIDOC_CONF = $(srcdir)/asciidoc.conf |
c4ee4984 | 56 | ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf |
ceb84f55 PP |
57 | XSL_FILES = \ |
58 | manpage.xsl \ | |
41af7458 | 59 | manpage-callouts.xsl \ |
ceb84f55 | 60 | manpage-bold-literal.xsl \ |
4d7f0487 | 61 | manpage-links.xsl |
ceb84f55 PP |
62 | XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES)) |
63 | ||
64 | # common dependencies | |
77c44a1d | 65 | COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT) $(ASCIIDOC_ATTRS_CONF) |
ceb84f55 | 66 | |
a3eae3c9 PP |
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 | |
ceb84f55 | 79 | # tools |
c4ee4984 | 80 | ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage |
ceb84f55 PP |
81 | ADOC_DOCBOOK = $(ADOC) -b docbook |
82 | XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man | |
83 | ||
84 | # recipes | |
85 | %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS) | |
86 | $(ADOC_DOCBOOK) -o $@ $< | |
87 | ||
88 | %.1: %.1.xml $(XSL_SRC_FILES) | |
89 | $(XTO) $< | |
90 | ||
91 | %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS) | |
92 | $(ADOC_DOCBOOK) -o $@ $< | |
93 | ||
94 | %.3: %.3.xml $(XSL_SRC_FILES) | |
95 | $(XTO) $< | |
96 | ||
97 | %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS) | |
98 | $(ADOC_DOCBOOK) -o $@ $< | |
99 | ||
100 | %.8: %.8.xml $(XSL_SRC_FILES) | |
101 | $(XTO) $< | |
102 | ||
a3eae3c9 PP |
103 | # only clean the generated files if we have the tools to generate them again |
104 | CLEANFILES = $(MAN_XML) $(MAN) | |
105 | else # HAVE_ASCIIDOC_XMLTO | |
106 | # create man page targets used to stop the build if we want to | |
107 | # build the man pages, but we don't have the necessary tools to do so | |
108 | ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing." | |
109 | ERR_MSG += "Make sure both tools are installed and run the configure script again." | |
110 | ||
111 | %.1: $(srcdir)/%.1.txt $(COMMON_DEPS) | |
112 | @echo $(ERR_MSG) | |
113 | @false | |
114 | ||
115 | %.3: $(srcdir)/%.3.txt $(COMMON_DEPS) | |
116 | @echo $(ERR_MSG) | |
117 | @false | |
118 | ||
119 | %.8: $(srcdir)/%.8.txt $(COMMON_DEPS) | |
120 | @echo $(ERR_MSG) | |
ceb84f55 | 121 | @false |
a3eae3c9 PP |
122 | endif # HAVE_ASCIIDOC_XMLTO |
123 | endif # MAN_PAGES_OPT | |
124 | ||
125 | # those are always installed since they are directly written in troff | |
126 | dist_man1_MANS = $(MAN1_NO_ASCIIDOC) | |
127 | dist_man3_MANS = $(MAN3_NO_ASCIIDOC) | |
128 | dist_man8_MANS = $(MAN8_NO_ASCIIDOC) | |
129 | ||
130 | if MAN_PAGES_OPT | |
131 | # building man pages: we can install and distribute them | |
ceb84f55 PP |
132 | dist_man1_MANS += $(MAN1) |
133 | dist_man3_MANS += $(MAN3) | |
134 | dist_man8_MANS += $(MAN8) | |
a3eae3c9 PP |
135 | endif # MAN_PAGES_OPT |
136 | ||
2f1c0906 PP |
137 | if !MAN_PAGES_OPT |
138 | dist-hook: | |
139 | @echo "Error: Please enable the man pages before creating a distribution tarball." | |
140 | @false | |
141 | endif # !MAN_PAGES_OPT | |
142 | ||
a3eae3c9 | 143 | # always distribute the source files |
c4ee4984 PP |
144 | EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \ |
145 | $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in |