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