[tor-bugs] #6875 [Tor Client]: Documentation fixes

Tor Bug Tracker & Wiki torproject-admin at torproject.org
Mon Sep 17 07:08:24 UTC 2012


#6875: Documentation fixes
------------------------+---------------------------------------------------
 Reporter:  grarpamp    |          Owner:                    
     Type:  task        |         Status:  new               
 Priority:  trivial     |      Milestone:  Tor: 0.2.4.x-final
Component:  Tor Client  |        Version:  Tor: 0.2.3.21-rc  
 Keywords:              |         Parent:                    
   Points:              |   Actualpoints:                    
------------------------+---------------------------------------------------
 Typos and other such trivialities...

 Whereas the other mentions (being the majority) in the code and spec trees
 use the non-hyphenated 'baseXX' form, these mentions need their hyphens
 removed for consistancy and grepability

 tor/src/common/crypto.h:258:/** Characters that can appear (case-
 insensitively) in a base-32 encoding. */
 tor/src/or/rendcommon.c:957:/** <b>query</b> is a base-32'ed service id.
 If it's malformed, return -1.
 torspec/rend-spec.txt:348:           The identifier of this introduction
 point: the base-32 encoded
 torspec/rend-spec.txt:529:   hostname of the form "z.onion", where z is a
 base-32 encoding of a

 tor/src/common/crypto.c:2520:/** Base-64 encode <b>srclen</b> bytes of
 data from <b>src</b>.  Write
 tor/src/common/crypto.c:2579:/** Base-64 decode <b>srclen</b> bytes of
 data from <b>src</b>.  Write
 tor/src/common/crypto.c:2686:/** Base-64 encode DIGEST_LINE bytes from
 <b>digest</b>, remove the trailing =
 tor/src/common/crypto.c:2699:/** Given a base-64 encoded, nul-terminated
 digest in <b>d64</b> (without
 tor/src/common/crypto.c:2724:/** Base-64 encode DIGEST256_LINE bytes from
 <b>digest</b>, remove the
 tor/src/common/crypto.c:2737:/** Given a base-64 encoded, nul-terminated
 digest in <b>d64</b> (without
 torspec/attic/dir-spec-v1.txt:50:    Object ::= BeginLine Base-64-encoded-
 data EndLine
 torspec/dir-spec-v2.txt:105:    Object ::= BeginLine Base-64-encoded-data
 EndLine
 torspec/dir-spec.txt:226:    Object ::= BeginLine Base-64-encoded-data
 EndLine
 torspec/dir-spec.txt:2327:   <Dn> are base-64 encoded with trailing =s
 omitted for size and for
 torspec/proposals/128-bridge-families.txt:56:  where %s is the base-64
 bridge password.
 torspec/proposals/154-automatic-updates.txt:119:    Object       ::=
 BeginLine Base-64-encoded-data EndLine
 torspec/proposals/ideas/xxx-new-crypto-sketch.txt:302:  use the notation
 %b64, where b64 is a base-64 encoding, omitting the
 torspec/proposals/ideas/xxx-new-crypto-sketch.txt:308:  Since 43 base-64
 characters is enough to represent a 256-bit digest,

 torspec/dir-spec-v2.txt:555:   "Fingerprints" in these URLs are
 base-16-encoded SHA1 hashes.
 torspec/dir-spec.txt:2362:   "Fingerprints" in these URLs are
 base-16-encoded SHA1 hashes.

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/6875>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list