doc/man/Makefile.am

   1 # Man pages are only built if they are enabled at configure time.
   2 #
   3 # They should always be built before creating a distribution tarball.
   4
   5 # Function which adds the source directory prefix and adds a given suffix:
   6 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
   7
   8 # List only the names without the .*.txt extension here:
   9 MAN1_NAMES = \
  10         lttng-gen-tp
  11 MAN3_NAMES = \
  12         lttng-ust \
  13         tracef \
  14         tracelog \
  15         lttng-ust-dl \
  16         lttng-ust-cyg-profile
  17
  18 # troff man pages:
  19 MAN3_TROFF = do_tracepoint.3 tracepoint.3 tracepoint_enabled.3
  20
  21 # AsciiDoc sources and outputs:
  22 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
  23 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
  24 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
  25 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
  26
  27 # Common AsciiDoc source files:
  28 COMMON_TXT = \
  29         $(srcdir)/common-footer.txt \
  30         $(srcdir)/common-authors.txt \
  31         $(srcdir)/common-copyrights.txt \
  32         $(srcdir)/log-levels.txt \
  33         $(srcdir)/tracef-tracelog-limitations.txt
  34
  35 # AsciiDoc configuration and XSL files:
  36 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
  37 XSL_FILE = $(srcdir)/manpage.xsl
  38
  39 # Common dependencies:
  40 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
  41
  42 # Man pages destinations:
  43 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
  44 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
  45 MAN = $(MAN1) $(MAN3)
  46
  47 if MAN_PAGES_OPT
  48 # At this point, we know the user asked to build the man pages.
  49 if HAVE_ASCIIDOC_XMLTO
  50
  51 asciidoc_verbose = $(asciidoc_verbose_@AM_V@)
  52 asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@)
  53 asciidoc_verbose_0 = @echo "  ASCIIDOC  " $@;
  54
  55 xmlto_verbose = $(xmlto_verbose_@AM_V@)
  56 xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@)
  57 xmlto_verbose_0 = @echo "  XMLTO     " $@;
  58
  59 # Tools to execute:
  60 ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
  61         -a lttng_ust_register_timeout="@LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS@" \
  62         -a mansource="LTTng" \
  63         -a manmanual="LTTng Manual" \
  64         -a manversion="$(PACKAGE_VERSION)"
  65
  66 ADOC_DOCBOOK = $(ADOC) -b docbook
  67 XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man
  68
  69 # Recipes:
  70 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
  71         $(ADOC_DOCBOOK) -o $@ $<
  72
  73 %.1: %.1.xml $(XSL_FILE)
  74         $(XTO) $< 2>/dev/null
  75
  76 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
  77         $(ADOC_DOCBOOK) -o $@ $<
  78
  79 %.3: %.3.xml $(XSL_FILE)
  80         $(XTO) $< 2>/dev/null
  81
  82 # Only clean the generated files if we have the tools to generate them again.
  83 CLEANFILES = $(MAN_XML) $(MAN)
  84 else # HAVE_ASCIIDOC_XMLTO
  85 # Create man page targets used to stop the build if we want to
  86 # build the man pages, but we don't have the necessary tools to do so.
  87 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
  88 ERR_MSG += "Make sure both tools are installed and run the configure script again."
  89
  90 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
  91         @echo $(ERR_MSG)
  92         @false
  93
  94 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
  95         @echo $(ERR_MSG)
  96         @false
  97 endif # HAVE_ASCIIDOC_XMLTO
  98 endif # MAN_PAGES_OPT
  99
 100 # Start with empty distributed/installed man pages:
 101 dist_man1_MANS =
 102 dist_man3_MANS =
 103 EXTRA_DIST =
 104
 105 if MAN_PAGES_OPT
 106 # Building man pages: we can install and distribute them.
 107 dist_man1_MANS += $(MAN1)
 108 dist_man3_MANS += $(MAN3) $(MAN3_TROFF)
 109 else # MAN_PAGES_OPT
 110 # Those are not known by automake yet because dist_man3_MANS is empty
 111 # at this point, so make sure they are distributed.
 112 EXTRA_DIST += $(MAN3_TROFF)
 113 endif # MAN_PAGES_OPT
 114
 115 if !MAN_PAGES_OPT
 116 dist-hook:
 117         @echo "Error: Please enable the man pages before creating a distribution tarball."
 118         @false
 119 endif # !MAN_PAGES_OPT
 120
 121 # Always distribute the source files.
 122 EXTRA_DIST += $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) $(ASCIIDOC_CONF) README.md