doc/man/Makefile.am

   1 # SPDX-License-Identifier: GPL-2.0-only
   2
   3 # Man pages are only built if they are enabled at configure time.
   4 #
   5 # They should always be built before creating a distribution tarball.
   6
   7 # function which adds the source directory prefix and adds a given suffix
   8 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
   9
  10 # Local targets.
  11 LOCAL =
  12
  13 # List only the names without the .*.txt extension here:
  14 MAN1_NAMES = \
  15         lttng \
  16         lttng-create \
  17         lttng-destroy \
  18         lttng-set-session \
  19         lttng-save \
  20         lttng-load \
  21         lttng-start \
  22         lttng-stop \
  23         lttng-version \
  24         lttng-view \
  25         lttng-enable-channel \
  26         lttng-disable-channel \
  27         lttng-add-context \
  28         lttng-list \
  29         lttng-track \
  30         lttng-untrack \
  31         lttng-status \
  32         lttng-help \
  33         lttng-snapshot \
  34         lttng-enable-event \
  35         lttng-disable-event \
  36         lttng-crash \
  37         lttng-metadata \
  38         lttng-regenerate \
  39         lttng-rotate \
  40         lttng-enable-rotation \
  41         lttng-disable-rotation \
  42         lttng-clear \
  43         lttng-add-trigger \
  44         lttng-remove-trigger \
  45         lttng-list-triggers
  46 MAN3_NAMES =
  47 MAN7_NAMES = lttng-event-rule lttng-concepts
  48 MAN8_NAMES = lttng-sessiond lttng-relayd
  49 MAN1_NO_ASCIIDOC_NAMES =
  50 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
  51 MAN7_NO_ASCIIDOC_NAMES =
  52 MAN8_NO_ASCIIDOC_NAMES =
  53
  54 # AsciiDoc sources and outputs
  55 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
  56 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
  57 MAN7_TXT = $(call manaddsuffix,.7.txt,$(MAN7_NAMES))
  58 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
  59 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN7_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-lttng-cmd-after-options.txt \
  66         $(srcdir)/common-lttng-cmd-options-head.txt \
  67         $(srcdir)/common-lttng-cmd-help-options.txt \
  68         $(srcdir)/common-help-option.txt \
  69         $(srcdir)/common-intro.txt \
  70         $(srcdir)/common-daemon-cfg.txt
  71
  72 # config
  73 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
  74 ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf
  75 XSL_FILE = $(srcdir)/manpage.xsl
  76
  77 # common dependencies
  78 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
  79
  80 # man pages destinations
  81 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
  82 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
  83 MAN7 = $(addsuffix .7,$(MAN7_NAMES))
  84 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
  85 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
  86 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
  87 MAN7_NO_ASCIIDOC = $(addsuffix .7,$(MAN7_NO_ASCIIDOC_NAMES))
  88 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
  89 MAN = $(MAN1) $(MAN3) $(MAN7) $(MAN8)
  90
  91 # initially empty
  92 CLEANFILES =
  93
  94 if EMBED_HELP
  95 mantoh_verbose = $(mantoh_verbose_@AM_V@)
  96 mantoh_verbose_ = $(mantoh_verbose_@AM_DEFAULT_V@)
  97 mantoh_verbose_0 = @echo "  MANTOH    " $@;
  98
  99 MAN1_H = $(addsuffix .1.h,$(MAN1_NAMES))
 100 MAN3_H = $(addsuffix .3.h,$(MAN3_NAMES))
 101 MAN8_H = $(addsuffix .8.h,$(MAN8_NAMES))
 102 MAN_H = $(MAN1_H) $(MAN3_H) $(MAN8_H)
 103 MAN_H_RECIPE = \
 104         $(mantoh_verbose_0)\
 105         MANWIDTH=80 @MANPROG@ --encoding=UTF-8 --no-hyphenation --no-justification --local-file $< > $@ ; \
 106         $(SED) -i 's/\\/\\\\/g' $@ ; \
 107         $(SED) -i 's/"/\\"/g' $@ ; \
 108         $(SED) -i 's/^\(.*\)$$/"\1\\n"/' $@
 109
 110 %.1.h: %.1
 111         $(MAN_H_RECIPE)
 112
 113 %.3.h: %.3
 114         $(MAN_H_RECIPE)
 115
 116 %.8.h: %.8
 117         $(MAN_H_RECIPE)
 118
 119 LOCAL += $(MAN_H)
 120
 121 CLEANFILES += $(MAN_H)
 122 endif # EMBED_HELP
 123
 124 if MAN_PAGES_OPT
 125 # at this point, we know the user asked to build the man pages
 126 if HAVE_ASCIIDOC_XMLTO
 127
 128 asciidoc_verbose = $(asciidoc_verbose_@AM_V@)
 129 asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@)
 130 asciidoc_verbose_0 = @echo "  ASCIIDOC  " $@;
 131
 132 xmlto_verbose = $(xmlto_verbose_@AM_V@)
 133 xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@)
 134 xmlto_verbose_0 = @echo "  XMLTO     " $@;
 135
 136 # tools
 137 ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
 138 ADOC_DOCBOOK = $(ADOC) -b docbook
 139 XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man
 140
 141 # only add this dependency if we can build the man pages because it's
 142 # a file generated by the configure script, so it's more recent than
 143 # the pregenerated man pages in a tarball
 144 COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
 145
 146 # recipes
 147 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
 148         $(ADOC_DOCBOOK) -o $@ $<
 149
 150 %.1: %.1.xml $(XSL_FILE)
 151         $(XTO) $< 2>/dev/null
 152
 153 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
 154         $(ADOC_DOCBOOK) -o $@ $<
 155
 156 %.3: %.3.xml $(XSL_FILE)
 157         $(XTO) $< 2>/dev/null
 158
 159 %.7.xml: $(srcdir)/%.7.txt $(COMMON_DEPS)
 160         $(ADOC_DOCBOOK) -o $@ $<
 161
 162 %.7: %.7.xml $(XSL_FILE)
 163         $(XTO) $< 2>/dev/null
 164
 165 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
 166         $(ADOC_DOCBOOK) -o $@ $<
 167
 168 %.8: %.8.xml $(XSL_FILE)
 169         $(XTO) $< 2>/dev/null
 170
 171 # only clean the generated files if we have the tools to generate them again
 172 CLEANFILES += $(MAN_XML) $(MAN)
 173 else # HAVE_ASCIIDOC_XMLTO
 174 # create man page targets used to stop the build if we want to
 175 # build the man pages, but we don't have the necessary tools to do so
 176 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
 177 ERR_MSG += "Make sure both tools are installed and run the configure script again."
 178
 179 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
 180         @echo $(ERR_MSG)
 181         @false
 182
 183 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
 184         @echo $(ERR_MSG)
 185         @false
 186
 187 %.7: $(srcdir)/%.7.txt $(COMMON_DEPS)
 188         @echo $(ERR_MSG)
 189         @false
 190
 191 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
 192         @echo $(ERR_MSG)
 193         @false
 194 endif # HAVE_ASCIIDOC_XMLTO
 195 endif # MAN_PAGES_OPT
 196
 197 # those are always installed since they are directly written in troff
 198 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
 199 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
 200 dist_man7_MANS = $(MAN7_NO_ASCIIDOC)
 201 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
 202
 203 if MAN_PAGES_OPT
 204 # building man pages: we can install and distribute them
 205 dist_man1_MANS += $(MAN1)
 206 dist_man3_MANS += $(MAN3)
 207 dist_man7_MANS += $(MAN7)
 208 dist_man8_MANS += $(MAN8)
 209 endif # MAN_PAGES_OPT
 210
 211 MAN_HIERARCHY = man1 man3 man7 man8
 212
 213 LOCAL += $(MAN_HIERARCHY)
 214
 215 CLEANFILES += $(MAN_HIERARCHY)
 216
 217 # Mimic mandb(8) path hierarchy -- as if installed -- by symlinking
 218 # sub-directories to the top man directory. This allows developers to read
 219 # the locally generated man pages. For example `$ ./pre-inst-env man lttng'.
 220 man1:
 221         @ln -s $(abs_builddir) $@
 222
 223 man3:
 224         @ln -s $(abs_builddir) $@
 225
 226 man7:
 227         @ln -s $(abs_builddir) $@
 228
 229 man8:
 230         @ln -s $(abs_builddir) $@
 231
 232 if !MAN_PAGES_OPT
 233 dist-hook:
 234         @echo "Error: Please enable the man pages before creating a distribution tarball."
 235         @false
 236 endif # !MAN_PAGES_OPT
 237
 238 # always distribute the source files
 239 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) \
 240         $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
 241
 242 # Build local targets.
 243 all-local: $(LOCAL)
 244
 245 # keep generated man pages that can be considered intermediate files
 246 .PRECIOUS: %.1 %.3 %.7 %.8