doc/include.am

   1 # We use a two-step process to generate documentation from asciidoc files.
   2 #
   3 # First, we use asciidoc/a2x to process the asciidoc files into .1.in and
   4 # .html.in files (see the asciidoc-helper.sh script). These are the same as
   5 # the regular .1 and .html files, except that they still have some autoconf
   6 # variables set in them.
   7 #
   8 # Second, we use config.status to turn .1.in files into .1 files and
   9 # .html.in files into .html files.
  10 #
  11 # We do the steps in this order so that we can ship the .*.in files as
  12 # part of the source distribution, so that people without asciidoc can
  13 # just use the .1 and .html files.
  14
  15 base_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify
  16 all_mans = $(base_mans)
  17 if USE_FW_HELPER
  18 install_mans = $(all_mans)
  19 else
  20 install_mans = $(base_mans)
  21 endif
  22
  23 if USE_ASCIIDOC
  24 nodist_man1_MANS = $(install_mans:=.1)
  25 doc_DATA = $(install_mans:=.html)
  26 html_in = $(all_mans:=.html.in)
  27 man_in = $(all_mans:=.1.in)
  28 txt_in = $(all_mans:=.1.txt)
  29 else
  30 html_in =
  31 man_in =
  32 txt_in =
  33 nodist_man1_MANS =
  34 doc_DATA =
  35 endif
  36
  37 EXTRA_DIST+= doc/asciidoc-helper.sh                     \
  38              $(html_in) $(man_in) $(txt_in)                     \
  39              doc/state-contents.txt                             \
  40              doc/torrc_format.txt                               \
  41              doc/TUNING                                         \
  42              doc/HACKING/README.1st.md                          \
  43              doc/HACKING/CodingStandards.md                     \
  44              doc/HACKING/GettingStarted.md                      \
  45              doc/HACKING/HelpfulTools.md                        \
  46              doc/HACKING/HowToReview.md                         \
  47              doc/HACKING/ReleasingTor.md                        \
  48              doc/HACKING/WritingTests.md
  49
  50 docdir = @docdir@
  51
  52 asciidoc_product = $(nodist_man1_MANS) $(doc_DATA)
  53
  54 # Generate the html documentation from asciidoc, but don't do
  55 # machine-specific replacements yet
  56 $(html_in) :
  57         $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh html @ASCIIDOC@ $(top_srcdir)/$@
  58
  59 # Generate the manpage from asciidoc, but don't do
  60 # machine-specific replacements yet
  61 $(man_in) :
  62         $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ $(top_srcdir)/$@
  63
  64 doc/tor.1.in: doc/tor.1.txt
  65 doc/torify.1.in: doc/torify.1.txt
  66 doc/tor-gencert.1.in: doc/tor-gencert.1.txt
  67 doc/tor-resolve.1.in: doc/tor-resolve.1.txt
  68
  69 doc/tor.html.in: doc/tor.1.txt
  70 doc/torify.html.in: doc/torify.1.txt
  71 doc/tor-gencert.html.in: doc/tor-gencert.1.txt
  72 doc/tor-resolve.html.in: doc/tor-resolve.1.txt
  73
  74 # use config.status to swap all machine-specific magic strings
  75 # in the asciidoc with their replacements.
  76 $(asciidoc_product) :
  77         $(AM_V_GEN)$(MKDIR_P) $(@D)
  78         $(AM_V_at)if test -e $(top_srcdir)/$@.in && ! test -e $@.in ; then \
  79                 cp $(top_srcdir)/$@.in $@; \
  80         fi
  81         $(AM_V_at)$(top_builddir)/config.status -q --file=$@;
  82
  83 doc/tor.html: doc/tor.html.in
  84 doc/tor-gencert.html: doc/tor-gencert.html.in
  85 doc/tor-resolve.html: doc/tor-resolve.html.in
  86 doc/torify.html: doc/torify.html.in
  87
  88 doc/tor.1: doc/tor.1.in
  89 doc/tor-gencert.1: doc/tor-gencert.1.in
  90 doc/tor-resolve.1: doc/tor-resolve.1.in
  91 doc/torify.1: doc/torify.1.in
  92
  93 CLEANFILES+= $(asciidoc_product)
  94 DISTCLEANFILES+= $(html_in) $(man_in)