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