diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING | 22 | ||||
| -rw-r--r-- | doc/tor-spec.txt | 5 | ||||
| -rw-r--r-- | doc/tor.1.in | 5 |
3 files changed, 12 insertions, 20 deletions
diff --git a/doc/HACKING b/doc/HACKING index 0ea9147834..09c780704a 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -53,14 +53,14 @@ the distant future, stuff may have changed.) util.[ch] -- Miscellaneous portability and convenience functions. Files in ./src/or: - + [General-purpose modules] or.h -- Common header file: include everything, define everything. - buffers.c -- Implements a generic buffer interface. Buffers are + buffers.c -- Implements a generic buffer interface. Buffers are fairly opaque string holders that can read to or flush from: - memory, file descriptors, or TLS connections. + memory, file descriptors, or TLS connections. Also implements parsing functions to read HTTP and SOCKS commands from buffers. @@ -89,7 +89,7 @@ the distant future, stuff may have changed.) results; clients use routers.c to parse them. dirserv.c -- Code to manage directory contents and generate - directories. [Directory server only] + directories. [Directory server only] routers.c -- Code to parse directories and router descriptors; and to generate a router descriptor corresponding to this OR's @@ -133,9 +133,9 @@ the distant future, stuff may have changed.) All sockets in Tor are handled as different types of nonblocking 'connections'. (What the Tor spec calls a "Connection", the code refers to as a "Cell-speaking" or "OR" connection.) - + Connections are implemented by the connection_t struct, defined in or.h. - Not every kind of connection uses all the fields in connection_t; see + Not every kind of connection uses all the fields in connection_t; see the comments in or.h and the assertions in assert_connection_ok() for more information. @@ -272,7 +272,7 @@ the distant future, stuff may have changed.) command_process_cell -- Notices it is a relay cell, so calls: command_process_relay_cell -- Looks up the circuit for the cell, makes sure the circuit is live, then passes the cell to: - circuit_deliver_relay_cell -- Passes the cell to each of: + circuit_deliver_relay_cell -- Passes the cell to each of: relay_crypt -- Strips a layer of encryption from the cell and notices that the cell is for local delivery. connection_edge_process_relay_cell -- extracts the cell's @@ -317,7 +317,6 @@ the distant future, stuff may have changed.) back an acknowledgement (requesting that more cells be sent to this stream). - 1.6. Routers, descriptors, and directories All Tor processes need to keep track of a list of onion routers, for @@ -348,7 +347,7 @@ the distant future, stuff may have changed.) directories. 1.7. Data model - + [XXX] 1.8. Flow control @@ -477,7 +476,6 @@ the distant future, stuff may have changed.) [XXX insert references] - # ====================================================================== # Old HACKING document; merge into the above, move into tor-design.tex, # or delete. @@ -574,7 +572,3 @@ Robustness features. Currently the code tries for the primary router first, and if it's down, chooses the first available twin. - - - - diff --git a/doc/tor-spec.txt b/doc/tor-spec.txt index 19e94af847..95e724287a 100644 --- a/doc/tor-spec.txt +++ b/doc/tor-spec.txt @@ -563,7 +563,6 @@ TODO: (very soon) cells when both a) the window is <= 450, and b) there are less than ten cell payloads remaining to be flushed at that edge. - 7. Directories and routers 7.1. Extensible information format @@ -712,7 +711,7 @@ items, a directory includes any number of router descriptors, and a single "signed-directory" - Indicates the start of a + Indicates the start of a "published" YYYY-MM-DD HH:MM:SS @@ -756,7 +755,7 @@ items, a directory includes any number of router descriptors, and a single 'verified' if its nickname AND digest match the one provided. [XXXX 'router-status' was added in 0.0.9pre5; older directory code uses 'running-routers' instead.] - + "directory-signature" nickname-of-dirserver NL Signature Note: The router descriptor for the directory server MUST appear first. diff --git a/doc/tor.1.in b/doc/tor.1.in index d49c5b89a0..b59b506ff8 100644 --- a/doc/tor.1.in +++ b/doc/tor.1.in @@ -95,7 +95,7 @@ servers haven't authenticated as "verified"? (Default: middle,rendezvous.) Every N seconds, Tor downloads a fresh directory, and re-uploads information about hidden services to the directory servers. If running as a server, Tor also re-uploads information about itself to -the directory servers. (Tor also uploads this information whenever it +the directory servers. (Tor also uploads this information whenever it changes.) (Default: 600.) .TP \fBClientOnly \fR\fB0\fR|\fB1\fR\fP @@ -217,7 +217,7 @@ If you have more than this number of onionskins queued for decrypt, reject new o .TP \fBMyFamily \fR\fInickname,nickname,...\fP Declare that this Tor server is controlled or administered by a group -or organization identical or similar to that of the other named servers. +or organization identical or similar to that of the other named servers. When two servers both declare that they are in the same 'family', Tor clients will not use them in the same circuit. .TP @@ -296,7 +296,6 @@ knows about, so it can tell which are up and which are down. This option is only useful for authoritative directories, so you probably don't want to use it. - .SH HIDDEN SERVICE OPTIONS .PP The following options are used to configure a hidden service. |