commit 456be93956d1f0acfa50dc3bc19ac6e2b9d2d77a Author: David Goulet dgoulet@torproject.org Date: Tue Jul 14 09:02:03 2020 -0400
doc: Move manpages into doc/man/
Closes #40044
Signed-off-by: David Goulet dgoulet@torproject.org --- .gitignore | 50 +++++++++++++-------------- changes/ticket40044 | 2 ++ configure.ac | 2 +- doc/include.am | 44 +++++++++++------------ doc/{ => man}/tor-gencert.1.txt | 0 doc/{ => man}/tor-print-ed-signing-cert.1.txt | 0 doc/{ => man}/tor-resolve.1.txt | 0 doc/{ => man}/tor.1.txt | 0 doc/{ => man}/torify.1.txt | 0 scripts/maint/checkOptionDocs.pl.in | 2 +- src/app/config/config.c | 2 +- src/app/config/testnet.inc | 2 +- src/lib/log/log.c | 2 +- 13 files changed, 54 insertions(+), 52 deletions(-)
diff --git a/.gitignore b/.gitignore index 97b145590e..aa39162cad 100644 --- a/.gitignore +++ b/.gitignore @@ -97,31 +97,31 @@ uptime-*.json /doc/Makefile /doc/Makefile.in /doc/doxygen -/doc/tor.1 -/doc/tor.1.in -/doc/tor.html -/doc/tor.html.in -/doc/tor.1.xml -/doc/tor-gencert.1 -/doc/tor-gencert.1.in -/doc/tor-gencert.html -/doc/tor-gencert.html.in -/doc/tor-gencert.1.xml -/doc/tor-resolve.1 -/doc/tor-resolve.1.in -/doc/tor-resolve.html -/doc/tor-resolve.html.in -/doc/tor-resolve.1.xml -/doc/torify.1 -/doc/torify.1.in -/doc/torify.html -/doc/torify.html.in -/doc/torify.1.xml -/doc/tor-print-ed-signing-cert.1 -/doc/tor-print-ed-signing-cert.1.in -/doc/tor-print-ed-signing-cert.html -/doc/tor-print-ed-signing-cert.html.in -/doc/tor-print-ed-signing-cert.1.xml +/doc/man/tor.1 +/doc/man/tor.1.in +/doc/man/tor.html +/doc/man/tor.html.in +/doc/man/tor.1.xml +/doc/man/tor-gencert.1 +/doc/man/tor-gencert.1.in +/doc/man/tor-gencert.html +/doc/man/tor-gencert.html.in +/doc/man/tor-gencert.1.xml +/doc/man/tor-resolve.1 +/doc/man/tor-resolve.1.in +/doc/man/tor-resolve.html +/doc/man/tor-resolve.html.in +/doc/man/tor-resolve.1.xml +/doc/man/torify.1 +/doc/man/torify.1.in +/doc/man/torify.html +/doc/man/torify.html.in +/doc/man/torify.1.xml +/doc/man/tor-print-ed-signing-cert.1 +/doc/man/tor-print-ed-signing-cert.1.in +/doc/man/tor-print-ed-signing-cert.html +/doc/man/tor-print-ed-signing-cert.html.in +/doc/man/tor-print-ed-signing-cert.1.xml
# /doc/spec/ /doc/spec/Makefile diff --git a/changes/ticket40044 b/changes/ticket40044 new file mode 100644 index 0000000000..8bd6d04e0a --- /dev/null +++ b/changes/ticket40044 @@ -0,0 +1,2 @@ + o Documentation (manpages): + - Move them from doc/ to doc/man/. Closes ticket 40044. diff --git a/configure.ac b/configure.ac index 75fd709f9b..3076f2f1ff 100644 --- a/configure.ac +++ b/configure.ac @@ -2611,7 +2611,7 @@ AC_CONFIG_FILES([ ])
if test "x$asciidoc" = "xtrue" && test "$ASCIIDOC" = "none"; then - regular_mans="doc/tor doc/tor-gencert doc/tor-resolve doc/torify" + regular_mans="doc/man/tor doc/man/tor-gencert doc/man/tor-resolve doc/man/torify" for file in $regular_mans ; do if ! [[ -f "$srcdir/$file.1.in" ]] || ! [[ -f "$srcdir/$file.html.in" ]] ; then echo "=================================="; diff --git a/doc/include.am b/doc/include.am index 5e0c90b0cd..d3e757f3bb 100644 --- a/doc/include.am +++ b/doc/include.am @@ -12,7 +12,7 @@ # part of the source distribution, so that people without asciidoc can # just use the .1 and .html files.
-all_mans = doc/tor doc/tor-gencert doc/tor-resolve doc/torify doc/tor-print-ed-signing-cert +all_mans = doc/man/tor doc/man/tor-gencert doc/man/tor-resolve doc/man/torify doc/man/tor-print-ed-signing-cert
if USE_ASCIIDOC txt_in = $(all_mans:=.1.txt) @@ -76,17 +76,17 @@ $(html_in) : $(man_in) : $(AM_V_GEN)$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ $(top_srcdir)/$@
-doc/tor.1.in: doc/tor.1.txt -doc/torify.1.in: doc/torify.1.txt -doc/tor-gencert.1.in: doc/tor-gencert.1.txt -doc/tor-resolve.1.in: doc/tor-resolve.1.txt -doc/tor-print-ed-signing-cert.1.in: doc/tor-print-ed-signing-cert.1.txt +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
-doc/tor.html.in: doc/tor.1.txt -doc/torify.html.in: doc/torify.1.txt -doc/tor-gencert.html.in: doc/tor-gencert.1.txt -doc/tor-resolve.html.in: doc/tor-resolve.1.txt -doc/tor-print-ed-signing-cert.html.in: doc/tor-print-ed-signing-cert.1.txt +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
# use config.status to swap all machine-specific magic strings # in the asciidoc with their replacements. @@ -97,17 +97,17 @@ $(asciidoc_product) : fi $(AM_V_at)$(top_builddir)/config.status -q --file=$@;
-doc/tor.html: doc/tor.html.in -doc/tor-gencert.html: doc/tor-gencert.html.in -doc/tor-resolve.html: doc/tor-resolve.html.in -doc/tor-print-ed-signing-cert.html: doc/tor-print-ed-signing-cert.html.in -doc/torify.html: doc/torify.html.in - -doc/tor.1: doc/tor.1.in -doc/tor-gencert.1: doc/tor-gencert.1.in -doc/tor-resolve.1: doc/tor-resolve.1.in -doc/tor-print-ed-signing-cert.1: doc/tor-print-ed-signing-cert.1.in -doc/torify.1: doc/torify.1.in +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
CLEANFILES+= $(asciidoc_product) DISTCLEANFILES+= $(html_in) $(man_in) diff --git a/doc/tor-gencert.1.txt b/doc/man/tor-gencert.1.txt similarity index 100% rename from doc/tor-gencert.1.txt rename to doc/man/tor-gencert.1.txt diff --git a/doc/tor-print-ed-signing-cert.1.txt b/doc/man/tor-print-ed-signing-cert.1.txt similarity index 100% rename from doc/tor-print-ed-signing-cert.1.txt rename to doc/man/tor-print-ed-signing-cert.1.txt diff --git a/doc/tor-resolve.1.txt b/doc/man/tor-resolve.1.txt similarity index 100% rename from doc/tor-resolve.1.txt rename to doc/man/tor-resolve.1.txt diff --git a/doc/tor.1.txt b/doc/man/tor.1.txt similarity index 100% rename from doc/tor.1.txt rename to doc/man/tor.1.txt diff --git a/doc/torify.1.txt b/doc/man/torify.1.txt similarity index 100% rename from doc/torify.1.txt rename to doc/man/torify.1.txt diff --git a/scripts/maint/checkOptionDocs.pl.in b/scripts/maint/checkOptionDocs.pl.in index 6533c762c5..bb8008c2e8 100644 --- a/scripts/maint/checkOptionDocs.pl.in +++ b/scripts/maint/checkOptionDocs.pl.in @@ -39,7 +39,7 @@ loadTorrc("@abs_top_srcdir@/src/config/torrc.sample.in", %torrcSampleOptions); # Try to figure out what's in the man page.
my $considerNextLine = 0; -open(F, "@abs_top_srcdir@/doc/tor.1.txt") or die; +open(F, "@abs_top_srcdir@/doc/man/tor.1.txt") or die; while (<F>) { if (m!^(?:[[([A-za-z0-9_]+)]] *)?**([A-Za-z0-9_]+)**!) { $manPageOptions{$2} = 1; diff --git a/src/app/config/config.c b/src/app/config/config.c index 10f09d7d98..f4172bd84e 100644 --- a/src/app/config/config.c +++ b/src/app/config/config.c @@ -27,7 +27,7 @@ * <li>The option_vars_ array below in this module, which configures * the names of the torrc options, their types, their multiplicities, * and their mappings to fields in or_options_t. - * <li>The manual in doc/tor.1.txt, to document what the new option + * <li>The manual in doc/man/tor.1.txt, to document what the new option * is, and how it works. * </ul> * diff --git a/src/app/config/testnet.inc b/src/app/config/testnet.inc index 605943d80b..00b307782b 100644 --- a/src/app/config/testnet.inc +++ b/src/app/config/testnet.inc @@ -1,5 +1,5 @@ // When modifying, don't forget to update the defaults -// for 'TestingTorNetwork' in 'doc/tor.1.txt' +// for 'TestingTorNetwork' in 'doc/man/tor.1.txt' { "DirAllowPrivateAddresses", "1" }, { "EnforceDistinctSubnets", "0" }, { "AuthDirMaxServersPerAddr", "0" }, diff --git a/src/lib/log/log.c b/src/lib/log/log.c index 9ee87c0668..cd848fdd73 100644 --- a/src/lib/log/log.c +++ b/src/lib/log/log.c @@ -1308,7 +1308,7 @@ log_level_to_string(int level) /** NULL-terminated array of names for log domains such that domain_list[dom] * is a description of <b>dom</b>. * - * Remember to update doc/tor.1.txt if you modify this list. + * Remember to update doc/man/tor.1.txt if you modify this list. * */ static const char *domain_list[] = { "GENERAL", "CRYPTO", "NET", "CONFIG", "FS", "PROTOCOL", "MM",