doc/man/Makefile.am

   1 # Man pages are only built if the --enable-build-man-pages option was passed
   2 # 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 MAN3_NAMES =
  24 MAN8_NAMES =
  25 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
  26 MAN3_NO_ASCIIDOC_NAMES =
  27 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
  28
  29 # man pages destinations
  30 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
  31 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
  32 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
  33 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
  34 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
  35 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
  36 MAN = $(MAN1) $(MAN3) $(MAN8)
  37
  38 # those are always installed since they are written in troff
  39 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
  40 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
  41 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
  42
  43 # only build man pages if it was enabled
  44 if BUILD_MAN_PAGES
  45 # dist + install
  46 dist_man1_MANS += $(MAN1)
  47 dist_man3_MANS += $(MAN3)
  48 dist_man8_MANS += $(MAN8)
  49
  50 # AsciiDoc sources and outputs
  51 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
  52 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
  53 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
  54 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
  55 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
  56
  57 # common AsciiDoc source files
  58 COMMON_TXT = \
  59         $(srcdir)/common-footer.txt \
  60         $(srcdir)/common-cmd-footer.txt \
  61         $(srcdir)/common-cmd-options-head.txt \
  62         $(srcdir)/common-cmd-help-options.txt
  63
  64 # config
  65 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
  66 XSL_FILES = \
  67         manpage.xsl \
  68         manpage-base.xsl \
  69         manpage-bold-literal.xsl \
  70         manpage-ulinks.xsl
  71 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
  72
  73 # common dependencies
  74 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
  75
  76 # tools
  77 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
  78         -a lttng_version=$(PACKAGE_VERSION)
  79 ADOC_DOCBOOK = $(ADOC) -b docbook
  80 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
  81
  82 # recipes
  83 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
  84         $(ADOC_DOCBOOK) -o $@ $<
  85
  86 %.1: %.1.xml $(XSL_SRC_FILES)
  87         $(XTO) $<
  88
  89 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
  90         $(ADOC_DOCBOOK) -o $@ $<
  91
  92 %.3: %.3.xml $(XSL_SRC_FILES)
  93         $(XTO) $<
  94
  95 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
  96         $(ADOC_DOCBOOK) -o $@ $<
  97
  98 %.8: %.8.xml $(XSL_SRC_FILES)
  99         $(XTO) $<
 100
 101 clean-local:
 102         rm -rf $(MAN_XML)
 103         rm -rf $(MAN)
 104 else
 105 if IN_GIT_REPO
 106 # we are in the Git repo: the man pages should be built for distribution
 107 dist-hook:
 108         @echo
 109         @echo 'Error: Please build the man pages before creating a tarball.'
 110         @echo
 111         @false
 112 else
 113 # we are in the tarball, hence the man pages are already built
 114 dist_man1_MANS += $(MAN1)
 115 dist_man3_MANS += $(MAN3)
 116 dist_man8_MANS += $(MAN8)
 117 endif # IN_GIT_REPO
 118 endif # BUILD_MAN_PAGES