Commit Graph

4514 Commits

Author SHA1 Message Date
David Goulet
456be93956 doc: Move manpages into doc/man/
Closes #40044

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 09:02:03 -04:00
Nick Mathewson
ecb43ce21c Merge branch 'maint-0.4.4' 2020-07-13 10:45:04 -04:00
JeremyRand
0be80fb650 Bug 31812: Change http URL's to https 2020-07-13 10:42:46 -04:00
Guinness
b119c55776 Syntax highlighting in the docs
This adds the syntax highlights in the MarkDown files.
Fixes #33741
2020-07-13 11:45:14 +02:00
Nick Mathewson
6fb1637255 Merge remote-tracking branch 'tor-gitlab/mr/29' 2020-07-10 12:53:46 -04:00
Nick Mathewson
be6b30e642 Merge branch 'maint-0.4.4' 2020-07-09 09:59:54 -04:00
David Goulet
942ecfa835 doc: Add a WARNING section to Tracing.md
Explain what is safe or not with tracing data.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 11:11:58 -04:00
David Goulet
79d6127a47 trace: Comments and improve doc/HACKING/Tracing.md
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 09:12:36 -04:00
David Goulet
66d5292ee6 Revert "config: Make clients tell dual-stack exits they prefer IPv6"
This reverts commit bf2a399fc0.

Don't set by default the prefer IPv6 feature on client ports because it breaks
the torsocks use case. The SOCKS resolve command is lacking a mechanism to ask
for a specific address family (v4 or v6) thus prioritizing IPv6 when an IPv4
address is asked on the resolve SOCKS interface resulting in a failure.

Tor Browser explicitly set PreferIPv6 so this should not affect the majority
of our users.

Closes #33796

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-07 12:58:41 -04:00
David Goulet
b039d3e803 Merge branch 'tor-github/pr/1953' 2020-07-01 09:47:26 -04:00
Nick Mathewson
5336ac2669 Move remaining CodeStructure.md contents into doxygen. 2020-06-26 10:11:42 -04:00
Nick Mathewson
a7aa97298b Remove special authority semantics for AssumeReachable.
AssumeReachable should only be about whether a relay thinks that it
is reachable itself.  But previously, we've had it also turn off
reachability checking of _other_ relays on authorities.
(Technically, reachability tests were still run, but we would ignore
the results.)

With this patch, there is a new AuthDirTestReachability option
(default 1) that controls whether authorities run reachability
tests.

Making this change allows us to have test networks where authorities
set AssumeReachable without disabling their reachability testing
entirely.

Closes ticket #34445.
2020-06-26 08:37:36 -04:00
Nick Mathewson
dbc2b75009 Merge branch 'assume_reachable_revamp' 2020-06-26 08:34:56 -04:00
Nick Mathewson
62e1d983cf Deprecate the "--dump-config non-builtin" option
When it works, "non-builtin" doesn't do anything different from
"short".  (When it doesn't work, it gives an assertion failure.)

Closes ticket #33398.
2020-06-25 10:01:40 -04:00
Nick Mathewson
edb023b1e7 Add an AssumeReachableIPv6 autobool option.
This option tells Tor that our IPv6 orport is reachable, and doesn't
need to be checked.

Closes the rest of 33224.
2020-06-24 15:25:34 -04:00
Nick Mathewson
9fdaede3f7 Remove AssumeReachable from TestingTorNetwork.
Closes ticket 34446.
2020-06-15 14:08:42 -04:00
Nick Mathewson
354f085e5f Merge remote-tracking branch 'tor-github/pr/1888/head' 2020-06-09 15:44:58 -04:00
c
284e9459b8
doc: specify C99 coding standards
Make clear that Tor's C code targets C99 standards. This makes it more
explicit what to expect for new code, because guessing from existing
code is not always reliable, especially for code that predates the
change in standard.
2020-06-04 13:28:24 +00:00
Nick Mathewson
b6e60f26dd Merge branch 'maint-0.4.3' 2020-06-01 09:50:04 -04:00
Roger Dingledine
d6186c7435 Man page: MinUptimeHidServDirectoryV2 defaults to 96 hours
Bugfix on 0.2.6.3-alpha; fixes bug 34299.
2020-05-23 04:37:57 -04:00
George Kadianakis
3121e5c103 Merge branch 'tor-github/pr/1850' 2020-05-21 16:24:32 +03:00
teor
e2bd15b6f3 doc: Some tor features may not work with MiddleNodes
And fix a formatting issue in the MiddleNodes man page entry.

Part of 33226.
2020-05-11 17:06:43 +10:00
Daniel Pinto
cc169eb120 Add documentation about %include and seccomp sandbox limitations 2020-05-08 00:21:12 +01:00
David Goulet
cd2121a126
client: Revert setting PreferIPv6 on by default
This change broke torsocks that by default is expecting an IPv4 for hostname
resolution because it can't ask tor for a specific IP version with the SOCKS5
extension.

PreferIPv6 made it that sometimes the IPv6 could be returned to torsocks that
was expecting an IPv4.

Torsocks is probably a very unique case because the runtime flow is that it
hijacks DNS resolution (ex: getaddrinfo()), gets an IP and then sends it back
for the connect() to happen.

The libc has DNS resolution functions that allows the caller to request a
specific INET family but torsocks can't tell tor to resolve the hostname only
to an IPv4 or IPv6 and thus by default fallsback to IPv4.

Reverting this change into 0.4.3.x series but we'll keep it in the 0.4.4.x
series in the hope that we add this SOCKS5 extension to tor for DNS resolution
and then change torsocks to use that.

Fixes #33804

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-04-09 11:05:32 +10:00
Roger Dingledine
9bd73da7cf fix typos from #32542 2020-04-08 19:13:52 -04:00
David Goulet
dd25805152 man: Update tor.1 ExtendedErrors section with latest
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-04-08 18:15:21 +03:00
teor
065ccda4f6
Merge branch 'pr1838_squashed' 2020-04-07 17:36:17 +10:00
teor
7adf72f1b4
Merge branch 'maint-0.4.3' 2020-04-05 17:17:51 +10:00
teor
80a306c6e7
doc: Fix another man page typo
The default value of the option is "auto", not "default".
2020-04-05 17:17:03 +10:00
teor
5c35bb38df
Merge branch 'maint-0.4.3' 2020-04-05 17:12:11 +10:00
teor
613077229f
doc: Fix a typo in the man page
"proceeding" means starting an action.
"preceding" means the thing before this thing.

In this context, it's a bit ambiguous.
2020-04-05 17:10:37 +10:00
teor
c0fe88b236
doc: Also stop running practracker in hooks
When making a new maint branch, stop running practracker in hooks.
2020-04-03 22:10:01 +10:00
teor
6db2e59f20
doc: Minor restructure for Release Lifecycle
* make end and beginning of life into second-level sections
* write an intro for beginning
* tweak intro for end
2020-04-03 22:06:27 +10:00
teor
0f10ddaa29
Re-apply: doc: Replace "underline" with "## Section name".
Re-applying changes after merge.
2020-04-03 22:02:11 +10:00
teor
0efcdb8918
Merge remote-tracking branch 'tor-github/pr/1739'
Ignored conflicting style changes: they will be re-applied in
the next commit.
2020-04-03 21:59:19 +10:00
teor
442e0caea2
Merge branch 'maint-0.4.3' 2020-04-03 14:44:34 +10:00
teor
7d2b6cacee
doc: Rewrite the approved-routers man page entry
Obviously correct documentation changes.
2020-04-03 14:43:48 +10:00
Steven Engler
cc5319bf8e Updated the TestingTorNetwork man page options
Updated 'doc/tor.1.txt' to match 'src/app/config/testnet.inc'.
2020-04-01 01:00:09 -04:00
Nick Mathewson
c323cc0913 Document the --dbg- prefix in tor.1 2020-03-26 12:17:28 -04:00
Bartosz Duszel
df22ee26fb doc: Remove TODO secion in README.1st.md
It seems like this section is not valid anymore.
Most of this topics are already explained in different
files.
2020-03-26 16:32:13 +01:00
Bartosz Duszel
b210aefb7f doc: Replace "underline" with "## Section name".
This approach doesn't require variable-length underlines.
2020-03-26 16:19:42 +01:00
Bartosz Duszel
af4b5eba34 doc: Remove first, empty line in the file. 2020-03-26 15:59:17 +01:00
Bartosz Duszel
8863408cad doc: Updates paths to the top of the source tree.
Example:
.../doc/HACKING is now doc/HACKING
2020-03-26 15:54:29 +01:00
Nick Mathewson
b1a571f038 Edits requested by teor 2020-03-23 09:27:16 -04:00
Bartosz Duszel
fd6a35eb59 Update README files with common style.
- external links use markdown's []() format,
- local files are formated with backquotes,
- duplicated new lines were removed,
- unnecesary single spaces were removed,
- broken links and local paths were updated.
2020-03-22 13:50:58 +01:00
teor
e9bb00d8c4
Merge branch 'maint-0.4.3' 2020-03-19 18:03:26 +10:00
teor
725efb7c98
doc: Fix a manual page typo
And consistently talk about extra-info document publishing.

Obviously correct documentation changes.
2020-03-19 18:02:32 +10:00
teor
fe5ecaa270
Merge branch 'maint-0.4.3' 2020-03-19 17:02:02 +10:00
teor
85414e1c18
doc: Fix a man page typo
Obviously correct changes to already-reviewed code.
2020-03-19 09:24:15 +10:00
David Goulet
05aab3fd21 Merge branch 'maint-0.4.3' 2020-03-10 09:14:44 -04:00
rl1987
72550c18c8 Tweak double-underscore 2020-03-10 09:13:29 -04:00
rl1987
94a2376e01 Document __OwningControllerProcess torrc option and mention polling interval 2020-03-10 09:13:19 -04:00
David Goulet
6684c6e17f Merge branch 'tor-github/pr/1751' 2020-03-09 09:33:05 -04:00
Neel Chauhan
7d673e70b0 Remove the ClientAutoIPv6ORPort option 2020-03-09 09:33:00 -04:00
rl1987
ef991b04e2 Refrain from mentioning nicknames in manpage section for MyFamily.
Also, fix a typo.
2020-03-05 17:41:49 +02:00
Nick Mathewson
c9bd3579f7 Tweak a couple of URLs in gettingstarted.md 2020-02-24 08:10:20 -05:00
Nick Mathewson
b6d9484fa7 Merge remote-tracking branch 'tor-github/pr/1761/head' 2020-02-24 08:06:42 -05:00
Nick Mathewson
caa392a73a Merge remote-tracking branch 'tor-github/pr/1685/head' 2020-02-24 07:45:20 -05:00
George Kadianakis
93cb8072be Final touches to #32709 based on Nick's feedback.
- Fix a bug and add unittest.
- Add changes file.
- Add man page entry.
2020-02-24 12:15:35 +02:00
Taylor Yu
b7c7feb2e4 manpage: fix up toc attribute 2020-02-20 16:49:08 -06:00
Nick Mathewson
09fb7987c5 Merge branch 'maint-0.4.3' 2020-02-20 08:50:18 -05:00
Nick Mathewson
f733b8acd6 Merge remote-tracking branch 'tor-github/pr/1719/head' into maint-0.4.3 2020-02-20 08:48:17 -05:00
swati
dba5c15893 #33369:Added TOC and hyperlinks for cross-refs 2020-02-20 17:50:32 +05:30
Roger Dingledine
98bf7604a3 fix typo from 7920fc35 2020-02-19 14:53:36 -05:00
Nick Mathewson
dca2c00aca Merge remote-tracking branch 'tor-github/pr/1755/head' 2020-02-19 11:39:05 -05:00
Taylor Yu
a46e585d6d manpage: Add a missing out-of-order comment 2020-02-18 13:28:57 -06:00
swati
fa48b0363e Revised and incorportaed comments from #33275 2020-02-17 22:47:06 +05:30
Nick Mathewson
455ea05bdf Rename EndOfLifeTor to ReleaseSeriesLifecycle; expand it.
Closes ticket 30917.
2020-02-14 08:47:17 -05:00
swati
7920fc3569 Update tor.1.txt 2020-02-14 00:34:39 +05:30
Nick Mathewson
3147cbba52 Merge remote-tracking branch 'tor-github/pr/1728/head' into maint-0.4.3 2020-02-12 13:48:39 -05:00
swati
d33c80f0ee Moved [[RephistTrackTime]] to General Options. 2020-02-12 23:17:31 +05:30
swati
809090d24d Addressed minor changes suggested in the ticket 2020-02-12 23:07:00 +05:30
David Goulet
f0964628e6 Merge branch 'ticket33029_042_01' into ticket33029_043_03
Conflicts:
	doc/tor.1.txt
	src/app/config/config.c
	src/app/config/or_options_st.h
	src/core/mainloop/connection.h

Between 042 and 043, the dirauth options were modularized so this merge commit
address this by moving the AuthDirRejectUncompressedRequests to the module
along with a series of accessors.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-02-11 10:30:29 -05:00
David Goulet
735aa208b1 dirauth: Add option AuthDirRejectRequestsUnderLoad
This controls the previous feature added that makes dirauth send back a 503
error code on non relay connections if under bandwidth pressure.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-02-11 09:57:05 -05:00
swati
725b0528e3 Alphabetized Server Options and Directory Server Options 2020-02-11 01:41:43 +05:30
Nick Mathewson
05a05773f2 Merge remote-tracking branch 'tor-github/pr/1711' 2020-02-10 10:23:50 -05:00
swati
305934c67b Updated introductory text for CIRCUIT TIMEOUT and DORMANT MODE options 2020-02-07 16:36:09 +05:30
swati
05adecf211 Added a section for Dormant mode options 2020-02-06 21:33:58 +05:30
swati
1b65024ae2 Added the NodeFamily option to Node Selection Options section 2020-02-05 23:13:41 +05:30
swati
d75d763155 Updated the introductory text and titles of Timeout and Node selection options 2020-02-05 00:28:27 +05:30
Roger Dingledine
90bb4872b8 go in to fix one typo, end up fixing more 2020-02-03 23:21:58 -05:00
swati
304aa4048c Added Timeout and Node Sections to the Tor Manual 2020-02-01 00:07:56 +05:30
Nick Mathewson
7c76cedf0f update doc/HACKING/ReleasingTor.md 2020-01-23 08:55:55 -05:00
David Goulet
ff93133403 Merge branch 'tor-github/pr/1675' 2020-01-20 10:47:49 -05:00
teor
51c76215db
doc: Minor man page fixes
Fix a client port list that's missing HTTPTunnelPort.

Wrap a long line.
2020-01-20 16:41:07 +10:00
teor
6898131b41
doc: Improve port flags in man page
Explain that:
* most flags default to off
* flags that default to on are specified

Document PreferIPv6Automap in its "No" form, because it's on by
default.

Cleanup after 32637.
2020-01-20 16:38:02 +10:00
teor
bf2a399fc0
config: Make clients tell dual-stack exits they prefer IPv6
Make Tor clients tell dual-stack exits that they prefer IPv6
connections.

This change is equivalent to setting the PreferIPv6 flag on
SOCKSPorts (and most other listener ports). Tor Browser has
been setting this flag for some time, and we want to remove a
client distinguisher at exits.

Also update the man page, putting all the IP flags in their
non-default forms.

Closes ticket 32637.
2020-01-20 16:36:58 +10:00
Nick Mathewson
3c89622e39 Merge branch 'ticket32487_squashed' into ticket32487_squashed_and_merged
Resolved conflicts in src/core/include.am
2020-01-16 07:57:37 -05:00
Nick Mathewson
888a0be0b9 Define a "dircache" module.
For now, this module is enabled whenever the relay module is
enabled, and disabled whenever the relay module is disabled.  Though
they are logically separate, the use cases for running one without
the other are rare enough that we don't really want to support
compiling them independently.
2020-01-16 07:48:17 -05:00
Neel Chauhan
8d288eb3a7 Deprecate the ClientAutoIPv6ORPort option 2020-01-13 14:55:16 -08:00
Nick Mathewson
8b46372f26 Merge branch 'pr_1643_squashed' 2020-01-13 13:26:23 -05:00
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
Nick Mathewson
4ceec4760c change some CI-substitute logic 2019-06-05 15:38:25 -04:00
rl1987
5d4b4f948a Mention Travis/Appveyor/Jenkins URLs in ReleasingTor.md 2019-05-31 09:35:19 +03:00
Nick Mathewson
d41427b054 A couple of suggestions from dgoulet on EndOfLife.md 2019-05-30 09:07:45 -04:00
Nick Mathewson
3ba2e04ee7 Minor tweaks on EOL process
First, clarify that this is for planned deprecations, not
security-related issues.

Second, we actually _don't_ want to remove the versions from the
approved list before the EOL date, or people will start getting
warnings too early.
2019-05-30 09:05:35 -04:00
teor
6263d9e13f doc: Add End of Life Tor instructions
Closes 28453.
2019-05-30 09:02:13 -04:00
teor
c390f1dd7e doc: Add a new Travis CI cron job when there's a new maint branch
Part of 28453.
2019-05-30 09:02:13 -04:00
Iain R. Learmonth
58cb98af32 Prop 301: No longer vote on RecommendedPackages
This is the first half of implementing proposal 301. The
RecommendedPackages torrc option is marked as obsolete and
the test cases for the option removed. Additionally, the code relating
to generating and formatting package lines in votes is removed.

These lines may still appear in votes from other directory authorities
running earlier versions of the code and so consensuses may still
contain package lines. A new consensus method will be needed to stop
including package lines in consensuses.

Fixes: #28465
2019-05-16 13:31:54 +01:00
Nick Mathewson
1c95bdb83b Merge branch 'ticket30452_035_v3' into ticket30452_041_v3 2019-05-14 19:20:53 -04:00
Nick Mathewson
1b16fcb70c Add a --list-modules command
Closes ticket 30452.
2019-05-14 19:19:53 -04:00