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 all_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify doc/tor-print-ed-signing-cert
  16
  17 if USE_ASCIIDOC
  18 nodist_man1_MANS = $(all_mans:=.1)
  19 doc_DATA = $(all_mans:=.html)
  20 html_in = $(all_mans:=.html.in)
  21 man_in = $(all_mans:=.1.in)
  22 txt_in = $(all_mans:=.1.txt)
  23 else
  24 html_in =
  25 man_in =
  26 txt_in =
  27 nodist_man1_MANS =
  28 doc_DATA =
  29 endif
  30
  31 EXTRA_DIST+= doc/asciidoc-helper.sh                     \
  32              $(html_in) $(man_in) $(txt_in)                     \
  33              doc/state-contents.txt                             \
  34              doc/torrc_format.txt                               \
  35              doc/TUNING                                         \
  36              doc/HACKING/README.1st.md                          \
  37              doc/HACKING/CodingStandards.md                     \
  38              doc/HACKING/CodingStandardsRust.md                 \
  39              doc/HACKING/CodeStructure.md                       \
  40              doc/HACKING/Fuzzing.md                             \
  41              doc/HACKING/GettingStarted.md                      \
  42              doc/HACKING/GettingStartedRust.md                  \
  43              doc/HACKING/HelpfulTools.md                        \
  44              doc/HACKING/HowToReview.md                         \
  45              doc/HACKING/Module.md                              \
  46              doc/HACKING/ReleasingTor.md                        \
  47              doc/HACKING/Tracing.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 doc/tor-print-ed-signing-cert.1.in: doc/tor-print-ed-signing-cert.1.txt
  69
  70 doc/tor.html.in: doc/tor.1.txt
  71 doc/torify.html.in: doc/torify.1.txt
  72 doc/tor-gencert.html.in: doc/tor-gencert.1.txt
  73 doc/tor-resolve.html.in: doc/tor-resolve.1.txt
  74 doc/tor-print-ed-signing-cert.html.in: doc/tor-print-ed-signing-cert.1.txt
  75
  76 # use config.status to swap all machine-specific magic strings
  77 # in the asciidoc with their replacements.
  78 $(asciidoc_product) :
  79         $(AM_V_GEN)$(MKDIR_P) $(@D)
  80         $(AM_V_at)if test -e $(top_srcdir)/$@.in && ! test -e $@.in ; then \
  81                 cp $(top_srcdir)/$@.in $@; \
  82         fi
  83         $(AM_V_at)$(top_builddir)/config.status -q --file=$@;
  84
  85 doc/tor.html: doc/tor.html.in
  86 doc/tor-gencert.html: doc/tor-gencert.html.in
  87 doc/tor-resolve.html: doc/tor-resolve.html.in
  88 doc/tor-print-ed-signing-cert.html: doc/tor-print-ed-signing-cert.html.in
  89 doc/torify.html: doc/torify.html.in
  90
  91 doc/tor.1: doc/tor.1.in
  92 doc/tor-gencert.1: doc/tor-gencert.1.in
  93 doc/tor-resolve.1: doc/tor-resolve.1.in
  94 doc/tor-print-ed-signing-cert.1: doc/tor-print-ed-signing-cert.1.in
  95 doc/torify.1: doc/torify.1.in
  96
  97 CLEANFILES+= $(asciidoc_product)
  98 DISTCLEANFILES+= $(html_in) $(man_in)