Opened 8 years ago

Closed 8 years ago

#6875 closed task (fixed)

Documentation fixes: base-{16,32,64}

Reported by: grarpamp Owned by:
Priority: Very Low Milestone: Tor: 0.2.4.x-final
Component: Core Tor/Tor Version: Tor:
Severity: Keywords: tor-client
Cc: onizuka.xxxx@… Actual Points:
Parent ID: Points:
Reviewer: Sponsor:


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. */
<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
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 =
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
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.

Child Tickets

Change History (6)

comment:1 Changed 8 years ago by nickm

Sure, I'd take a patch for this. Or somebody could even clean this up with a perl one-liner.

comment:2 Changed 8 years ago by nickm

Summary: Documentation fixesDocumentation fixes: base-{16,32,64}

comment:3 Changed 8 years ago by nickm

Keywords: tor-client added

comment:4 Changed 8 years ago by nickm

Component: Tor ClientTor

comment:5 Changed 8 years ago by onizuka

Cc: onizuka.xxxx@… added
Status: newneeds_review

Here is a one-liner with sed:

find ./ -type f -perm -u+rw -exec sed -ri 's/(Base)-(16|32|64)/\1\2/gi' {} \;

comment:6 Changed 8 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Applied to tor and torspec (except for attic and proposals). Thanks!

(I recommend * instead of . , actually, so that it can't hit anything in .git)

Note: See TracTickets for help on using tickets.