diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING | 13 | ||||
| -rw-r--r-- | doc/Makefile.am | 20 | ||||
| -rw-r--r-- | doc/spec/control-spec.txt | 4 | ||||
| -rw-r--r-- | doc/spec/rend-spec.txt | 2 | ||||
| -rw-r--r-- | doc/spec/tor-spec.txt | 5 | ||||
| -rw-r--r-- | doc/tor.1.txt | 13 |
6 files changed, 28 insertions, 29 deletions
diff --git a/doc/HACKING b/doc/HACKING index ac68a35a0..d8538b1f2 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -50,15 +50,16 @@ When you do a commit that needs a ChangeLog entry, add a new file to the "changes" toplevel subdirectory. It should have the format of a one-entry changelog section from the current ChangeLog file, as in - o Major bugfixes: - - Fix a potential buffer overflow. Fixes bug 9999. Bugfix on - Tor 0.3.1.4-beta. + o Major bugfixes: + - Fix a potential buffer overflow. Fixes bug 9999; bugfix on + 0.3.1.4-beta. To write a changes file, first categorize the change. Some common categories are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code -simplifications and refactoring. Then say what the change does. Then, if -it's a bugfix, then mention what bug it fixes and when the bug was -introduced. +simplifications and refactoring. Then say what the change does. If +it's a bugfix, mention what bug it fixes and when the bug was +introduced. To find out which Git tag the change was introduced in, +you can use "git describe --contains <sha1 of commit>". If at all possible, try to create this file in the same commit where you are making the change. Please give it a distinctive name that no diff --git a/doc/Makefile.am b/doc/Makefile.am index 2e70fd747..68747c8d2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -15,25 +15,27 @@ if USE_ASCIIDOC asciidoc_files = tor tor-gencert tor-resolve torify +html_in = $(asciidoc_files:=.html.in) +man_in = $(asciidoc_files:=.1.in) +txt_in = $(asciidoc_files:=.1.txt) +nodist_man_MANS = $(asciidoc_files:=.1) +doc_DATA = $(asciidoc_files:=.html) else asciidoc_files = +html_in = +man_in = +txt_in = +nodist_man_MANS = +doc_DATA = endif -html_in = ${asciidoc_files:=.html.in} - -man_in = ${asciidoc_files:=.1.in} - EXTRA_DIST = HACKING asciidoc-helper.sh \ - $(html_in) $(man_in) ${asciidoc_files:=.1.txt} \ + $(html_in) $(man_in) $(txt_in) \ tor-osx-dmg-creation.txt tor-rpm-creation.txt \ tor-win32-mingw-creation.txt -nodist_man_MANS = ${asciidoc_files:=.1} - docdir = @docdir@ -doc_DATA = ${asciidoc_files:=.html} - asciidoc_product = $(nodist_man_MANS) $(doc_DATA) SUBDIRS = spec diff --git a/doc/spec/control-spec.txt b/doc/spec/control-spec.txt index 5a68864b2..31ce35074 100644 --- a/doc/spec/control-spec.txt +++ b/doc/spec/control-spec.txt @@ -92,7 +92,7 @@ 2.4. General-use tokens - ; CRLF means, "the ASCII Carriage Return character (decimal value value 13) + ; CRLF means, "the ASCII Carriage Return character (decimal value 13) ; followed by the ASCII Linefeed character (decimal value 10)." CRLF = CR LF @@ -1049,7 +1049,7 @@ Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" / "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" / - "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" / + "NOROUTE" / "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" / "CONNRESET" / "TORPROTOCOL" / "NOTDIRECTORY" / "END" The "REASON" field is provided only for FAILED, CLOSED, and DETACHED diff --git a/doc/spec/rend-spec.txt b/doc/spec/rend-spec.txt index d440c8a81..12e20df65 100644 --- a/doc/spec/rend-spec.txt +++ b/doc/spec/rend-spec.txt @@ -9,7 +9,7 @@ RFC 2119. Read - https://www.torproject.org/doc/design-paper/tor-design.html#sec:rendezvous + https://svn.torproject.org/svn/projects/design-paper/tor-design.html#sec:rendezvous before you read this specification. It will make more sense. Rendezvous points provide location-hidden services (server diff --git a/doc/spec/tor-spec.txt b/doc/spec/tor-spec.txt index f448f6da2..2b1223ba7 100644 --- a/doc/spec/tor-spec.txt +++ b/doc/spec/tor-spec.txt @@ -835,7 +835,8 @@ see tor-design.pdf. 6 -- REASON_DONE (Anonymized TCP connection was closed) 7 -- REASON_TIMEOUT (Connection timed out, or OR timed out while connecting) - 8 -- (unallocated) [**] + 8 -- REASON_NOROUTE (Routing error while attempting to + contact destination) 9 -- REASON_HIBERNATING (OR is temporarily hibernating) 10 -- REASON_INTERNAL (Internal error at the OR) 11 -- REASON_RESOURCELIMIT (OR has no resources to fulfill request) @@ -857,8 +858,6 @@ see tor-design.pdf. [*] Older versions of Tor also send this reason when connections are reset. - [**] Due to a bug in versions of Tor through 0095, error reason 8 must - remain allocated until that version is obsolete. --- [The rest of this section describes unimplemented functionality.] diff --git a/doc/tor.1.txt b/doc/tor.1.txt index db623c8da..3b7e30bdf 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -965,23 +965,20 @@ is non-zero): **CellStatistics** **0**|**1**:: When this option is enabled, Tor writes statistics on the mean time that - cells spend in circuit queues to disk every 24 hours. Cannot be changed - while Tor is running. (Default: 0) + cells spend in circuit queues to disk every 24 hours. (Default: 0) **DirReqStatistics** **0**|**1**:: When this option is enabled, Tor writes statistics on the number and - response time of network status requests to disk every 24 hours. Cannot be - changed while Tor is running. (Default: 0) + response time of network status requests to disk every 24 hours. + (Default: 0) **EntryStatistics** **0**|**1**:: When this option is enabled, Tor writes statistics on the number of - directly connecting clients to disk every 24 hours. Cannot be changed while - Tor is running. (Default: 0) + directly connecting clients to disk every 24 hours. (Default: 0) **ExitPortStatistics** **0**|**1**:: When this option is enabled, Tor writes statistics on the number of relayed - bytes and opened stream per exit port to disk every 24 hours. Cannot be - changed while Tor is running. (Default: 0) + bytes and opened stream per exit port to disk every 24 hours. (Default: 0) **ExtraInfoStatistics** **0**|**1**:: When this option is enabled, Tor includes previously gathered statistics in |