sarah
/
tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
tor/doc/include.am

68 lines
2.1 KiB
Plaintext
Raw Normal View History

Add a comment explaining the doc build system Updated a little by Sebastian
2010-01-21 04:28:32 +00:00
# We use a two-step process to generate documentation from asciidoc files.
#
# First, we use asciidoc/a2x to process the asciidoc files into .1.in and
# .html.in files (see the asciidoc-helper.sh script). These are the same as
# the regular .1 and .html files, except that they still have some autoconf
# variables set in them.
#
# Second, we use config.status to turn .1.in files into .1 files and
# .html.in files into .html files.
#
# We do the steps in this order so that we can ship the .*.in files as
# part of the source distribution, so that people without asciidoc can
# just use the .1 and .html files.
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
regular_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify
all_mans = $(regular_mans) doc/tor-fw-helper
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 11:55:32 +00:00
Add configure switch to disable use of asciidoc Also break the build if that switch isn't used and asciidoc isn't available.
2010-03-01 02:17:48 +00:00
if USE_ASCIIDOC
Build the tor-fw-helper manpage So far we just had the asciidoc manpage, but didn't build it.
2010-09-30 20:44:11 +00:00
if USE_FW_HELPER
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
man_MANS = $(all_mans:=.1)
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 11:55:32 +00:00
doc_DATA = $(all_mans:=.html)
Build the tor-fw-helper manpage So far we just had the asciidoc manpage, but didn't build it.
2010-09-30 20:44:11 +00:00
else
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
man_MANS = $(regular_mans:=.1)
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 11:55:32 +00:00
doc_DATA = $(regular_mans:=.html)
Build the tor-fw-helper manpage So far we just had the asciidoc manpage, but didn't build it.
2010-09-30 20:44:11 +00:00
endif
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 11:55:32 +00:00
html_in = $(all_mans:=.html.in)
man_in = $(all_mans:=.1.in)
txt_in = $(all_mans:=.1.txt)
Add configure switch to disable use of asciidoc Also break the build if that switch isn't used and asciidoc isn't available.
2010-03-01 02:17:48 +00:00
else
Bug #1773: Revert bad fix (4ef609b8) and do it properly. * doc/Makefile.am: Move $(VAR:MOD) expansions inside "if USE_ASCIIDOC". * doc/Makefile.am: Use proper variable name for text input files. * doc/Makefile.am: Initialize vars to empty when !USE_ASCIIDOC.
2010-08-09 19:44:21 +00:00
html_in =
man_in =
txt_in =
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
man_MANS =
Bug #1773: Revert bad fix (4ef609b8) and do it properly. * doc/Makefile.am: Move $(VAR:MOD) expansions inside "if USE_ASCIIDOC". * doc/Makefile.am: Use proper variable name for text input files. * doc/Makefile.am: Initialize vars to empty when !USE_ASCIIDOC.
2010-08-09 19:44:21 +00:00
doc_DATA =
Add configure switch to disable use of asciidoc Also break the build if that switch isn't used and asciidoc isn't available.
2010-03-01 02:17:48 +00:00
endif
Allow generating documentation from asciidoc in the Makefile
2010-01-18 21:15:38 +00:00
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
EXTRA_DIST+= doc/HACKING doc/asciidoc-helper.sh \
$(html_in) $(man_in) $(txt_in) \
doc/tor-rpm-creation.txt \
doc/tor-win32-mingw-creation.txt doc/spec/README \
doc/state-contents.txt
some early bugfixes our log() conflicts with log(3) distribute only the correct files from doc/ and src/config/ sometimes laptops go back in time. i guess that's ok for now. and bump the version number because we're live. svn:r544
2003-10-07 16:30:05 +00:00
Make sure docdir is defined when making doc/ Apparently some autoconf versions need this, while others don't. This means documentation will be installed into share/doc/tor/.
2010-01-28 07:59:20 +00:00
docdir = @docdir@
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
asciidoc_product = $(man_MANS) $(doc_DATA)
Move design-paper into its own directory, and ship it and all that is needed to build with it in the tarball svn:r2163
2004-08-06 19:54:29 +00:00
Allow generating documentation from asciidoc in the Makefile
2010-01-18 21:15:38 +00:00
# Generate the html documentation from asciidoc, but don't do
# machine-specific replacements yet
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
$(html_in) : $(txt_in)
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
$(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh html @ASCIIDOC@ $(top_srcdir)/$@
Allow generating documentation from asciidoc in the Makefile
2010-01-18 21:15:38 +00:00
# Generate the manpage from asciidoc, but don't do
# machine-specific replacements yet
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
$(man_in) : $(txt_in)
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
$(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ $(top_srcdir)/$@
Allow generating documentation from asciidoc in the Makefile
2010-01-18 21:15:38 +00:00
# use ../config.status to swap all machine-specific magic strings
# in the asciidoc with their replacements.
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
$(asciidoc_product) : $(txt_in) $(man_in)
$(MKDIR_P) $(@D)
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
$(AM_V_GEN)if test -e $(top_srcdir)/$@.in && ! test -e $@.in ; then \
Fix up make distcheck and greatly simplify docs dependencies (although it's still a bit odd)
2012-08-03 01:20:52 +00:00
cp $(top_srcdir)/$@.in $@; \
Make the asciidoc build process work from outside top_srcdir Edited a little by Sebastian
2010-01-21 04:32:27 +00:00
fi
fix up calling of config.status to generate docs
2012-08-03 01:26:21 +00:00
$(AM_V_GEN)./config.status --file=$@;
Clean the man and html files with make (dist)clean
2010-01-27 19:23:13 +00:00
Move to non-recursive make This gives us a few benefits: 1) make -j clean all this will start working, as it should. It currently doesn't. 2) increased parallel build recursive make will max out at number of files in a directory, non-recursive make doesn't have such a limitation 3) Removal of duplicate information in make files, less error prone I've also slightly updated how we call AM_INIT_AUTOMAKE, as the way that was used was not only deprecated but will be *removed* in the next major automake release (1.13).... so probably best that we can continue to bulid tor without requiring old automake. (see http://www.gnu.org/software/automake/manual/html_node/Public-Macros.html ) For more reasons why, see resources such as: http://miller.emu.id.au/pmiller/books/rmch/
2012-08-02 13:31:43 +00:00
CLEANFILES+= $(asciidoc_product) config.log
DISTCLEANFILES+= $(html_in) $(man_in)