mirrors/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2025-02-25 15:10:48 +01:00
Code Issues Projects Releases Wiki Activity
tor/doc/include.am

115 lines
3.6 KiB
Text
Raw Normal View History

Add a comment explaining the doc build system Updated a little by Sebastian
2010-01-20 23:28:32 -05: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.
doc: Move manpages into doc/man/ Closes #40044 Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
all_mans = doc/man/tor doc/man/tor-gencert doc/man/tor-resolve doc/man/torify doc/man/tor-print-ed-signing-cert
Fix build of torify.1 The build was broken by changes in f8c45339f72525c68, but we didn't notice, since that commit also made torify.1 only get built when tor-fw-helper was turned on. Fixes bug 11321; bugfix on Tor 0.2.5.1-alpha.
2014-03-26 12:11:38 -04:00
if USE_ASCIIDOC
Allow excluding documentation from the build
2019-06-16 20:18:30 +03:00
txt_in = $(all_mans:=.1.txt)
if BUILD_HTML_DOCS
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 13:55:32 +02:00
html_in = $(all_mans:=.html.in)
Allow excluding documentation from the build
2019-06-16 20:18:30 +03:00
doc_DATA = $(all_mans:=.html)
else
html_in =
doc_DATA =
endif
if BUILD_MANPAGE
nodist_man1_MANS = $(all_mans:=.1)
Ensure the release tarball contains all manpages Thanks to Nick for the idea for the fix.
2011-06-12 13:55:32 +02:00
man_in = $(all_mans:=.1.in)
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 03:17:48 +01:00
else
Allow excluding documentation from the build
2019-06-16 20:18:30 +03:00
nodist_man1_MANS =
man_in =
endif
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 21:44:21 +02:00
html_in =
Allow excluding documentation from the build
2019-06-16 20:18:30 +03:00
doc_DATA =
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 21:44:21 +02:00
man_in =
txt_in =
Replace man_MANS with nodist_man1_MANS (commit message by nickm)
2012-08-23 12:36:31 -04:00
nodist_man1_MANS =
Allow excluding documentation from the build
2019-06-16 20:18:30 +03: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 03:17:48 +01:00
endif
Allow generating documentation from asciidoc in the Makefile
2010-01-18 22:15:38 +01:00
Move hacking documentation into a new subdirectory.
2015-10-09 09:28:24 -04:00
EXTRA_DIST+= doc/asciidoc-helper.sh \
Tabify all of the .am files.
2018-07-01 09:37:28 -04:00
$(html_in) $(man_in) $(txt_in) \
doc/state-contents.txt \
doc/torrc_format.txt \
Doxygen: provide a style sheet This sheet tries to make links to the source code browser less obtrusive.
2019-11-05 13:04:51 -05:00
doc/tor-doxygen.css \
Add doc/WritingTests.txt to distribution
2015-09-03 10:30:54 -04:00
doc/TUNING \
hacking is now markdown Not good markdown, mind you.
2015-10-29 10:30:27 -04:00
doc/HACKING/README.1st.md \
doc/HACKING/CodingStandards.md \
doc: Add missing HACKING/ files to EXTRA_DIST Apart from adding the newly created Module.md, this commit also adds all the missing files we have in HACKING/ to the EXTRA_DIST. Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-05-02 14:28:40 -04:00
doc/HACKING/CodingStandardsRust.md \
doc/HACKING/Fuzzing.md \
hacking is now markdown Not good markdown, mind you.
2015-10-29 10:30:27 -04:00
doc/HACKING/GettingStarted.md \
doc: Add missing HACKING/ files to EXTRA_DIST Apart from adding the newly created Module.md, this commit also adds all the missing files we have in HACKING/ to the EXTRA_DIST. Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-05-02 14:28:40 -04:00
doc/HACKING/GettingStartedRust.md \
hacking is now markdown Not good markdown, mind you.
2015-10-29 10:30:27 -04:00
doc/HACKING/HelpfulTools.md \
doc/HACKING/HowToReview.md \
doc: Add missing HACKING/ files to EXTRA_DIST Apart from adding the newly created Module.md, this commit also adds all the missing files we have in HACKING/ to the EXTRA_DIST. Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-05-02 14:28:40 -04:00
doc/HACKING/Module.md \
hacking is now markdown Not good markdown, mind you.
2015-10-29 10:30:27 -04:00
doc/HACKING/ReleasingTor.md \
doc/HACKING/WritingTests.md
doc: Fix wrong path in include.am Tracing.md moved to doc/tracing/ so fix the distcheck path in include.am. Also add the new EventsCircuit.md file. Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 14:07:33 -04:00
doc/HACKING/tracing/Tracing.md \
doc/HACKING/tracing/EventsCircuit.md
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 08:59:20 +01:00
docdir = @docdir@
Replace man_MANS with nodist_man1_MANS (commit message by nickm)
2012-08-23 12:36:31 -04:00
asciidoc_product = $(nodist_man1_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 22:15:38 +01:00
# Generate the html documentation from asciidoc, but don't do
# machine-specific replacements yet
Fix dependency checking on manpage builds Fixes bug 6843; bugfix on 0.2.4.1-alpha.
2012-09-14 10:36:42 -04:00
$(html_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 23:31:43 +10: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 22:15:38 +01:00
# Generate the manpage from asciidoc, but don't do
# machine-specific replacements yet
Fix dependency checking on manpage builds Fixes bug 6843; bugfix on 0.2.4.1-alpha.
2012-09-14 10:36:42 -04:00
$(man_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 23:31:43 +10: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 22:15:38 +01:00
doc: Move manpages into doc/man/ Closes #40044 Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
doc/man/tor.1.in: doc/man/tor.1.txt
doc/man/torify.1.in: doc/man/torify.1.txt
doc/man/tor-gencert.1.in: doc/man/tor-gencert.1.txt
doc/man/tor-resolve.1.in: doc/man/tor-resolve.1.txt
doc/man/tor-print-ed-signing-cert.1.in: doc/man/tor-print-ed-signing-cert.1.txt
Fix dependency checking on manpage builds Fixes bug 6843; bugfix on 0.2.4.1-alpha.
2012-09-14 10:36:42 -04:00
doc: Move manpages into doc/man/ Closes #40044 Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
doc/man/tor.html.in: doc/man/tor.1.txt
doc/man/torify.html.in: doc/man/torify.1.txt
doc/man/tor-gencert.html.in: doc/man/tor-gencert.1.txt
doc/man/tor-resolve.html.in: doc/man/tor-resolve.1.txt
doc/man/tor-print-ed-signing-cert.html.in: doc/man/tor-print-ed-signing-cert.1.txt
Fix dependency checking on manpage builds Fixes bug 6843; bugfix on 0.2.4.1-alpha.
2012-09-14 10:36:42 -04:00
Use output variables instead of relative paths. Fixes the following rules in out-of-tree builds; - check-spaces - check-docs - check-logs - Doxygen - coverage-html And cleans up additional directories; - coverage_html - doc/doxygen
2015-02-17 15:36:10 +01:00
# use config.status to swap all machine-specific magic strings
Allow generating documentation from asciidoc in the Makefile
2010-01-18 22:15:38 +01:00
# in the asciidoc with their replacements.
Fix dependency checking on manpage builds Fixes bug 6843; bugfix on 0.2.4.1-alpha.
2012-09-14 10:36:42 -04:00
$(asciidoc_product) :
Better fix to avoid loudness on mkdir -p (commit message by nickm)
2012-08-27 10:05:02 -04:00
$(AM_V_GEN)$(MKDIR_P) $(@D)
$(AM_V_at)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 11:20:52 +10:00
cp $(top_srcdir)/$@.in $@; \
Better fix to avoid loudness on mkdir -p (commit message by nickm)
2012-08-27 10:05:02 -04:00
fi
Use output variables instead of relative paths. Fixes the following rules in out-of-tree builds; - check-spaces - check-docs - check-logs - Doxygen - coverage-html And cleans up additional directories; - coverage_html - doc/doxygen
2015-02-17 15:36:10 +01:00
$(AM_V_at)$(top_builddir)/config.status -q --file=$@;
Clean the man and html files with make (dist)clean
2010-01-27 20:23:13 +01:00
doc: Move manpages into doc/man/ Closes #40044 Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
doc/man/tor.html: doc/man/tor.html.in
doc/man/tor-gencert.html: doc/man/tor-gencert.html.in
doc/man/tor-resolve.html: doc/man/tor-resolve.html.in
doc/man/tor-print-ed-signing-cert.html: doc/man/tor-print-ed-signing-cert.html.in
doc/man/torify.html: doc/man/torify.html.in
doc/man/tor.1: doc/man/tor.1.in
doc/man/tor-gencert.1: doc/man/tor-gencert.1.in
doc/man/tor-resolve.1: doc/man/tor-resolve.1.in
doc/man/tor-print-ed-signing-cert.1: doc/man/tor-print-ed-signing-cert.1.in
doc/man/torify.1: doc/man/torify.1.in
Add missing dependency so the html.in files get built
2012-08-23 12:52:33 -04:00
Remove config.log from CLEANFILES Fixes bug 17924; bugfix on 0.2.4.1-alpha. In ddf5020ea8d51, we added config.log to CLEANFILES in doc/Makefile.am so that distcheck would be happy about the presence of doc/config.log. But when we moved to nonrecursie makefiles in 2a4a1496241d6, we accidentally left that filename unchanged, so that it referred to config.log instead. Patch from cypherpunks.
2015-12-22 20:46:15 -05:00
CLEANFILES+= $(asciidoc_product)
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 23:31:43 +10:00
DISTCLEANFILES+= $(html_in) $(man_in)
Reference in a new issue Copy permalink