doc/man/Makefile.am

   1 # SPDX-License-Identifier: LGPL-2.1-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 # List only the names without the .*.txt extension here:
  11 MAN1_NAMES = \
  12         lttng-gen-tp
  13 MAN3_NAMES = \
  14         lttng-ust \
  15         lttng-ust-dl \
  16         lttng-ust-cyg-profile \
  17         lttng_ust_tracef \
  18         lttng_ust_tracelog \
  19         tracef \
  20         tracelog
  21
  22 # Man page aliases (generated from other sources):
  23 MAN3_ALIASES = lttng_ust_vtracef.3 lttng_ust_vtracelog.3
  24
  25 # troff man pages:
  26 MAN3_TROFF = \
  27         do_tracepoint.3 \
  28         lttng_ust_do_tracepoint.3 \
  29         lttng_ust_tracepoint.3 \
  30         lttng_ust_tracepoint_enabled.3 \
  31         tracepoint.3 \
  32         tracepoint_enabled.3
  33
  34 # AsciiDoc sources and outputs:
  35 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
  36 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
  37 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
  38 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
  39
  40 # Common AsciiDoc source files:
  41 COMMON_TXT = \
  42         $(srcdir)/common-footer.txt \
  43         $(srcdir)/common-authors.txt \
  44         $(srcdir)/common-copyrights.txt \
  45         $(srcdir)/log-levels.txt \
  46         $(srcdir)/tracef-tracelog-limitations.txt
  47
  48 # AsciiDoc configuration and XSL files:
  49 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
  50 XSL_FILE = $(srcdir)/manpage.xsl
  51
  52 # Common dependencies:
  53 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
  54
  55 # Man pages destinations:
  56 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
  57 MAN3 = $(addsuffix .3,$(MAN3_NAMES)) $(MAN3_ALIASES)
  58 MAN = $(MAN1) $(MAN3)
  59
  60 if ENABLE_MAN_PAGES
  61 # At this point, we know the user asked to build the man pages.
  62 if HAVE_ASCIIDOC_XMLTO
  63
  64 asciidoc_verbose = $(asciidoc_verbose_@AM_V@)
  65 asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@)
  66 asciidoc_verbose_0 = @echo "  ASCIIDOC  " $@;
  67
  68 xmlto_verbose = $(xmlto_verbose_@AM_V@)
  69 xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@)
  70 xmlto_verbose_0 = @echo "  XMLTO     " $@;
  71
  72 xmlto_verbose_out = $(xmlto_verbose_out_@AM_V@)
  73 xmlto_verbose_out_ = $(xmlto_verbose_out_@AM_DEFAULT_V@)
  74 xmlto_verbose_out_0 = 2>/dev/null
  75
  76 # Tools to execute:
  77 ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
  78         -a mansource="LTTng" \
  79         -a manmanual="LTTng Manual" \
  80         -a manversion="$(PACKAGE_VERSION)"
  81
  82 ADOC_DOCBOOK = $(ADOC) -b docbook
  83 XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man
  84
  85 # Recipes:
  86 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
  87         $(ADOC_DOCBOOK) -o $@ $<
  88
  89 %.1: %.1.xml $(XSL_FILE)
  90         $(XTO) $< $(xmlto_verbose_out)
  91
  92 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
  93         $(ADOC_DOCBOOK) -o $@ $<
  94
  95 # These pair of files are generated by a single invocation of xmlto, use
  96 # an empty rule that depends on a fake intermediate file to track the
  97 # dependencies without resorting to Group Targets which were only
  98 # introduced in GNU Make 4.3.
  99 lttng_ust_tracef.3 lttng_ust_vtracef.3: lttng_ust_tracef.3.alias
 100         @# Empty recipe to mark lttng_ust_tracef.3 and lttng_ust_vtracef.3 as rebuilt
 101
 102 lttng_ust_tracelog.3 lttng_ust_vtracelog.3: lttng_ust_tracelog.3.alias
 103         @# Empty recipe to mark lttng_ust_tracelog.3 and lttng_ust_vtracelog.3 as rebuilt
 104
 105
 106 .INTERMEDIATE: tracef.3.alias tracelog.3.alias lttng_ust_tracef.3.alias lttng_ust_tracelog.3.alias
 107
 108 tracef.3.alias: tracef.3.xml $(XSL_FILE)
 109         $(XTO) $< $(xmlto_verbose_out)
 110
 111 tracelog.3.alias: tracelog.3.xml $(XSL_FILE)
 112         $(XTO) $< $(xmlto_verbose_out)
 113
 114 lttng_ust_tracef.3.alias: lttng_ust_tracef.3.xml $(XSL_FILE)
 115         $(XTO) $< $(xmlto_verbose_out)
 116
 117 lttng_ust_tracelog.3.alias: lttng_ust_tracelog.3.xml $(XSL_FILE)
 118         $(XTO) $< $(xmlto_verbose_out)
 119
 120 %.3: %.3.xml $(XSL_FILE)
 121         $(XTO) $< $(xmlto_verbose_out)
 122
 123 # Only clean the generated files if we have the tools to generate them again.
 124 CLEANFILES = $(MAN_XML) $(MAN)
 125 else # HAVE_ASCIIDOC_XMLTO
 126 # Create man page targets used to stop the build if we want to
 127 # build the man pages, but we don't have the necessary tools to do so.
 128 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
 129 ERR_MSG += "Make sure both tools are installed and run the configure script again."
 130
 131 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
 132         @echo $(ERR_MSG)
 133         @false
 134
 135 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
 136         @echo $(ERR_MSG)
 137         @false
 138 endif # HAVE_ASCIIDOC_XMLTO
 139 endif # ENABLE_MAN_PAGES
 140
 141 # Start with empty distributed/installed man pages:
 142 dist_man1_MANS =
 143 dist_man3_MANS =
 144 EXTRA_DIST =
 145
 146 if ENABLE_MAN_PAGES
 147 # Building man pages: we can install and distribute them.
 148 dist_man1_MANS += $(MAN1)
 149 dist_man3_MANS += $(MAN3) $(MAN3_TROFF)
 150 else # ENABLE_MAN_PAGES
 151 # Those are not known by automake yet because dist_man3_MANS is empty
 152 # at this point, so make sure they are distributed.
 153 EXTRA_DIST += $(MAN3_TROFF)
 154 endif # ENABLE_MAN_PAGES
 155
 156 if !ENABLE_MAN_PAGES
 157 dist-hook:
 158         @echo "Error: Please enable the man pages before creating a distribution tarball."
 159         @false
 160 endif # !ENABLE_MAN_PAGES
 161
 162 # Always distribute the source files.
 163 EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) $(ASCIIDOC_CONF) README.md