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