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