Commit Graph

4323 Commits

Author SHA1 Message Date
Taylor Yu
d99e7cebb9 manpage: group some SafeSocks-related options
Move some SafeSocks-related options near each other.  Part of ticket
32846.
2020-01-13 13:26:13 -05:00
Taylor Yu
cfd21cc213 manpge: reorder some padding-related options
Move ReducedCircuitPadding and ReducedConnectionPadding immediately
after the corresponding non-Reduced options.  Part of ticket 32846.
2020-01-13 13:26:13 -05:00
Taylor Yu
4e597673b7 manpage: GuardfractionFile is authority-only
Only directory authorities use the GuardfractionFile option, so move
it to that section.  Part of ticket 32846.
2020-01-13 13:26:13 -05:00
Swati Thacker
ec52c8ed69 manpage: alphabetize client options
Alphabetize client options in tor.1.txt.  Closes ticket32846.
2020-01-13 13:26:12 -05:00
Nick Mathewson
93894fb770 Merge branch 'ticket22029_attempt_squashed' 2020-01-09 15:27:32 -05:00
Neel Chauhan
84d8dd8314 Update tor.1 man page for Bug #22029 2020-01-09 15:27:26 -05:00
Nick Mathewson
1b63eea66c Merge branch 'haxxpop/tcp_proxy_squashed' into tcp_proxy_squshed_and_merged 2020-01-06 13:41:20 -05:00
Nick Mathewson
9276c07a91 Merge remote-tracking branch 'tor-github/pr/1615' 2020-01-06 13:32:33 -05:00
Nick Mathewson
e08d07692f Add documentation about building a TAGS file.
Patch from opara.  Closes ticket 32779.
2020-01-06 13:31:30 -05:00
Nick Mathewson
42e31b5c45 Mark TestingEstimatedDescriptorPropagationTime as obsolete.
We stopped looking at this option in 85cf6dcba3, back when we
implemented the minimal pieces of prop275.  Since then, we've had
code to validate and adjust this option, and to give it a different
value in testing networks, but the option hasn't actually done
anything.

We can safely mark it as OBSOLETE, since doing so does not make any
old configuration get rejected.

Closes ticket 32807.
2019-12-19 11:04:48 -05:00
Mike Perry
b7dbb4a554 Add NSF support acknowledgment to circpad dev doc. 2019-12-17 17:10:40 -06:00
teor
11c8c4f23c
Merge branch 'pr1590_amended_commit' 2019-12-17 09:49:30 +10:00
Taylor Yu
616c0f823c
manpage: fixes to alphabetize General Options 2019-12-17 09:48:57 +10:00
Mike Perry
981350815d Add circuit padding developer and quickstart docs. 2019-12-16 22:00:54 +02:00
Taylor Yu
645acaf138 manpage: fix some quoting
Fix some quoting, especially of constructs like "[address:]port", that
were proving tricky for Asciidoctor tooling to parse correctly.

Also fix formatting of some configuration variable names that
contained double underscores.  Neither asciidoc nor asciidoctor was
rendering some of those correctly.

Part of ticket 32708.
2019-12-12 11:19:35 -06:00
Taylor Yu
6f31d7e048 manpage: section titles to 1-line
Change the section title formatting to use the one-line format.  This
allows Asciidoctor-based tooling to parse it more easily.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Taylor Yu
8dff1d342d manpage: indent linebreak markup
Indent the asciidoc markup for lone linebreaks to match the preceding
paragraph line, so that Asciidoctor tools can format them correctly.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Taylor Yu
1e3f53d613 manpage: minor formatting fixes
These are unrelated changes done by Swati while doing the alphabetizing.

Part of ticket 32708.
2019-12-12 10:44:21 -06:00
Swati Thacker
21b3073b9a manpage: alphabetize General Options
Part of ticket 32708.
2019-12-12 10:44:21 -06:00
teor
68b6d85248
Merge branch 'maint-0.4.2'
Merge tor_free() notes with whitespace fixes.
2019-11-25 12:52:10 +10:00
teor
eb81704081
CodingStandards: Use consistent spacing
* 2 newlines before ====== headers
* 1 newline before ------ headers
2019-11-25 12:50:15 +10:00
teor
03867b3dd7
Merge branch 'maint-0.4.2' 2019-11-25 12:37:26 +10:00
teor
969ee5d77f
CodingStandards: Use the correct changes file format
And remove a duplicate description of the format.

Obviously correct changes to documentation.
2019-11-25 11:44:22 +10:00
Nick Mathewson
d8ff7d0236 Merge branch 'reversible_3' 2019-11-21 07:49:18 -05:00
David Goulet
709d7fba11 hs-v3: Return bad address SOCKS5 extended error
If ExtendedErrors is set for the SocksPort, an invalid .onion address now
returns the 0xF6 error code per prop304.

Closes #30022

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-21 13:02:29 +02:00
Nick Mathewson
a30d143228 Make KeyDirectory's GroupReadable behave the same as CacheDirectory's.
In #26913 we solved a bug where CacheDirectoryGroupReadable would
override DataDirectoryGroupReadable when the two directories are the
same.  We never did the same for KeyDirectory, though, because
that's a rare setting.

Now that I'm testing this code, though, fixing this issue seems
fine.  Fixes bug #27992; bugfix on 0.3.3.1-alpha.
2019-11-20 09:26:47 -05:00
George Kadianakis
d28b6792cb Merge branch 'tor-github/pr/1423' 2019-11-18 19:06:53 +02:00
David Goulet
d60ed5a6a2 doc: Manpage entry for ExtendedErrors of prop304
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-18 19:06:43 +02:00
Nick Mathewson
fc1316b559 Merge branch 'ticket32467' 2019-11-12 13:19:12 -05:00
Nick Mathewson
f221a7aaf6 Fold remainder of this-not-that.md into CodingStandards.md 2019-11-12 12:28:14 -05:00
Nick Mathewson
c11c1d0623 Merge remote-tracking branch 'tor-github/pr/1367' 2019-11-12 12:18:14 -05:00
Nick Mathewson
e39423c78c Remove 01e-os-compat: the module docs cover this much better. 2019-11-12 12:14:56 -05:00
Nick Mathewson
6744f6b6bb HACKING/design: move 01c-time.md into doxygen. 2019-11-12 12:14:14 -05:00
Nick Mathewson
b0f9ecdbb1 Move 01g-strings.md into doxygen. 2019-11-12 12:09:53 -05:00
Nick Mathewson
d1a1631a05 01f-threads.md becomes threading.dox. 2019-11-12 12:05:05 -05:00
Nick Mathewson
91f377deec HACKING/design: turn the remaining parts of crypto into a certs doc 2019-11-12 12:01:33 -05:00
Nick Mathewson
89396bc726 HACKING/design: remove 03-modules as superseded.
The src/feature directory documentation now covers this better.
2019-11-12 11:56:53 -05:00
Nick Mathewson
6d9db29dda Document --dump-config.
Closes ticket 32467.
2019-11-12 08:19:35 -05:00
George Kadianakis
8344776224 Merge branch 'tor-github/pr/1504' 2019-11-11 14:47:33 +02:00
Nick Mathewson
32a2f96f82 Add the ability to fail when a hardware accelerator is missing.
Closes ticket 32406.
2019-11-07 07:28:43 -05:00
Nick Mathewson
58d7f9e68b Remove Makefile from doc/HACKING/design 2019-11-06 15:47:29 -05:00
Nick Mathewson
83cab05398 Remove 00-overview.md as already subsumed by doxygen 2019-11-06 15:47:00 -05:00
Nick Mathewson
3ae87c3c7f Turn the "dataflow" document into a doxygen page. 2019-11-06 12:50:57 -05:00
Nick Mathewson
d7872b775d Doxygen: provide a style sheet
This sheet tries to make links to the source code browser less obtrusive.
2019-11-05 13:50:01 -05:00
Nick Mathewson
e1cdca2e4f directory-level doxygen for "src/core" 2019-11-04 16:28:28 -05:00
Nick Mathewson
607b1ff776 Move much of 00-overview.md into doxygen. 2019-11-04 12:24:46 -05:00
Nick Mathewson
a5085c52d0 Move most of crypto overview into doxygen. 2019-11-04 12:10:28 -05:00
Nick Mathewson
211a2e0a8f Move doc/HACKING/design/01b-collections.md into doxygen. 2019-11-04 12:07:38 -05:00
Nick Mathewson
fb20618e28 Divide 01a-memory.md into doxygen. 2019-11-04 12:04:32 -05:00
Nick Mathewson
4bf73dfa26 Remove now-superseded part of doc/HACKING/design. 2019-11-04 11:52:49 -05:00
teor
40e75bc3e1
doc: Add defaults for some transport options 2019-10-31 11:27:26 +10:00
Taylor Yu
5e4ae73051 Reformat some options in tor.1.txt
Reformat command line options in tor.1.txt to display as fixed-width
in the HTML version.  Based on a patch by Swati Thacker.  Part of
ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
8660a32d18 Reword command-options in tor.1.txt
Reword the COMMAND-LINE OPTIONS section of tor.1.txt.  Based on a
patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
90ba8bae3f Reword DESCRIPTION in tor.1.txt
Reword the DESCRIPTION section of tor.1.txt.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
4c38fccb9b Move command-line conf option description earlier
In tor.1.txt, move the paragraphs at the end of the COMMAND-LINE
OPTIONS section earlier.  This text describes how the user can specify
configuration options on the command line.

Also clarify some wording and formatting.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Nick Mathewson
9a66b33229 A little more text in the SEE ALSO section. 2019-10-24 11:45:07 -04:00
Nick Mathewson
fefee871a6 Merge remote-tracking branch 'tor-github/pr/1437' 2019-10-24 11:44:19 -04:00
teor
9db1602ec5
Merge branch 'maint-0.4.2' 2019-10-23 08:47:30 +10:00
Philipp Winter
80a198928e
Remove outdated note.
BridgeDB supports bridge-distribution lines since version 0.5.0:
<https://bugs.torproject.org/23957>
2019-10-23 07:52:05 +10:00
Roger Dingledine
4233fb7014
clarify in man page: we count by powers of two
Make clear in the man page, in both the bandwidth section and the
accountingmax section, that Tor counts in powers of two, not
powers of ten: 1 GByte is 1024*1024*1024 bytes, not one billion
bytes.

Resolves ticket 32106.
2019-10-23 07:50:20 +10:00
Taylor Yu
6f8fad54fd Reword back matter of tor.1.txt
Reword the SEE ALSO and BUGS sections of tor.1.txt.  Based on a patch
by Swati Thacker.  Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
8b9b51a6cb Reformat some file names in tor.1.txt
Reformat file name headings in the FILES section of tor.1.txt to
display as fixed-width in the HTML version.

Based on a patch by Swati Thacker.  Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
e8fe6bd8d6 Reword FILES section of tor.1.txt
Reword the FILES section of tor.1.txt.  Based on a patch by Swati
Thacker.

Part of #32176.
2019-10-21 16:20:12 -05:00
Taylor Yu
a4e83cd5e5 Remove redundant FILES entry in tor.1.txt
There was a redundant entry for approved-routers in the FILES section
of tor.1.txt.

Part of #32176.
2019-10-21 16:20:12 -05:00
teor
0973575737
doc/HACKING: Update Module.md for the relay module
Also fix some typos, and delete some obsolete instructions.

Part of 32123.
2019-10-20 20:26:06 +10:00
Suphanat Chunhapanya
1b07a2d7bf doc: Add TCPProxy option
TCPProxy is used for proxying all outgoing OR connections through some
proxy with the protocol specified in the option.
2019-10-17 15:33:16 +08:00
Roger Dingledine
71daad1692 never say XB, always XBytes
fix three more instances in the man page that we forgot to fix
in earlier attempts
2019-10-16 03:31:23 -04:00
Nick Mathewson
1332d3b6fa doc/HACKING/design: address comments from ahf 2019-10-14 15:53:04 -04:00
Nick Mathewson
358436592b Edit 01b-collections.md a bit for md and missing content 2019-10-14 15:05:47 -04:00
Nick Mathewson
77accf937e Edit 01a-memory.md 2019-10-14 15:02:26 -04:00
Nick Mathewson
8ef5d96c2e Rewrite "common" overview into a "lib" overview. 2019-10-14 13:49:27 -04:00
Nick Mathewson
908070bbd5 Rename common-utils to lib-overview. 2019-10-14 10:59:32 -04:00
Nick Mathewson
1b996b01f6 00-overview.md: Revise to describe intended document structure 2019-10-14 10:58:03 -04:00
David Goulet
1f60337da4 Merge branch 'tor-github/pr/1381' 2019-10-08 14:49:39 -04:00
Roger Dingledine
aa56465934 fix typo in how-to-review guidelines 2019-10-07 00:48:11 -04:00
George Kadianakis
723288a32f Improve v3 client auth documentation in the man page. 2019-10-01 13:39:34 +03:00
Nick Mathewson
6581f3e2fa Fix the documentation for GuardLifetime. 2019-09-30 14:54:52 -04:00
George Kadianakis
de66bed604 Merge branch 'tor-github/pr/1366' 2019-09-30 14:01:01 +03:00
rl1987
b4aeeb77ba Merge advice from this_not_that.md in torguts repo into our main coding standard doc 2019-09-25 17:15:12 +03:00
Nick Mathewson
469051f650 Copy architectural documentation from tor-guts.git repository
I started this repository a while ago to work on documentation for
Tor's internals.  It needs substantial revision, but first, let's
get it copied into Tor's repository.

These files are copied, "warts and all", from the tor-guts.git repo,
commit de1e34259178b09861c0dea319c760fa80d0099a.

Part of 31819.
2019-09-24 19:26:04 -04:00
teor
102546f99f
doc: Document the signal-safe log behaviour in the tor man page
Part of 31389.
2019-09-24 15:03:17 +10:00
David Goulet
e5cf1423fd man: Entry for the HS intro DoS defenses
This also adds a "subsection" to the HIDDEN SERVICE OPTIONS section to
seperate per-service and per-instance options. It is a bit less messy this
way.

The HS DoS options are added to the per-service section.

Part of #30924

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-08-26 15:53:46 +03:00
Nick Mathewson
6ba05eea8e Merge remote-tracking branch 'tor-github/pr/1247' 2019-08-24 16:32:50 -04:00
Antoine Veuiller
3bf90e704c doc(hacking): update = to # on sections 2019-08-21 16:22:37 +02:00
Antoine Veuiller
0d6c8eed49 doc(hacking): enhance markdown style 2019-08-21 16:22:08 +02:00
teor
e87e34099c
Fix typos in HiddenServiceExportCircuitID
Closes bug 31418.
2019-08-15 18:58:10 +10:00
teor
f65f4b5c38
Merge remote-tracking branch 'tor-github/pr/1020' into maint-0.3.5 2019-08-12 09:49:53 +10:00
teor
a57e168caa
Merge remote-tracking branch 'tor-github/pr/741' into maint-0.3.5 2019-08-12 09:36:14 +10:00
rl1987
ffce19a9ec Make tor-print-ed-signing-cert output RFC1123 and unix timestamps as well 2019-07-10 11:36:26 +03:00
George Kadianakis
15e28af2d1 Merge remote-tracking branch 'dgoulet/ticket31008_035_01' 2019-07-02 13:19:40 +03:00
David Goulet
f446db59e1 man: Fix -help typo to --help
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-06-27 14:52:12 -04:00
David Goulet
c34a6b922f Merge branch 'tor-github/pr/1129' 2019-06-27 10:19:45 -04:00
teor
362afa8c4e doc: update the man page entries for DirAuthority and FallbackDir
Improve the documentation for the DirAuthority and FallbackDir torrc
options.

Closes ticket 30955.
2019-06-27 10:19:40 -04:00
teor
872b85e689
Merge branch 'bug30956_041' into bug30956_master 2019-06-24 19:47:34 +10:00
teor
8356cc5b51 stats: Always publish pluggable transports in extra info documents
Always publish bridge pluggable transport information in the extra info
descriptor, even if ExtraInfoStatistics is 0. This information is
needed by BridgeDB.

Fixes bug 30956; bugfix on 0.4.1.1-alpha.
2019-06-24 19:44:24 +10:00
rl1987
66a15013fa Allow excluding documentation from the build 2019-06-16 20:21:30 +03:00
George Kadianakis
7b3efc386f Merge branch 'tor-github/pr/1102' 2019-06-12 13:00:20 +03:00
David Goulet
8e112cecd8 Merge branch 'tor-github/pr/1031' 2019-06-11 11:46:38 -04:00
Nick Mathewson
4313f1cce8 Merge branch 'ticket28453_v2' into ticket28453_v2_merged 2019-06-11 10:22:37 -04:00
Nick Mathewson
765e4364d9 Merge remote-tracking branch 'tor-github/pr/1064' into maint-0.4.1 2019-06-10 09:37:17 -04:00