Permalink
Browse files

doc/checksums: use $HASHTYPE for referring to hash names

$NAME is potentially ambiguous and $HASHTYPE matches the
database column name.
  • Loading branch information...
1 parent 1fd5ef4 commit 4937ade9aeb2c80b5d3c3548bfb0a5bf5b3999f9 Eric Wong committed with dormando Mar 22, 2012
Showing with 3 additions and 3 deletions.
  1. +3 −3 doc/checksums.txt
View
@@ -11,15 +11,15 @@ tracker protocol
Hex is used instead of binary over the wire, hex is already immune to
URL encoding in the tracker protocol.
-Hashes are represented with in the $NAME:$HEXDIGEST format:
+Hashes are represented with in the $HASHTYPE:$HEXDIGEST format:
MD5:68b329da9893e34099c7d8ad5cb9c940
verifying checksums (on disk)
-----------------------------
Ideally, mogstored checksum calculation is done by mogstored and only
-the checksum (in $NAME=$HEXDIGEST format) is sent over the wire.
+the checksum (in $HASHTYPE=$HEXDIGEST format) is sent over the wire.
If mogstored is not available, the checksum is calculated on the tracker
by streaming the file with HTTP GET.
@@ -30,7 +30,7 @@ create_close (query worker)
New optional parameters:
- checksumverify=(0|1) default: 0 (false)
-- checksum=$NAME:$HEXDIGEST
+- checksum=$HASHTYPE:$HEXDIGEST
If "checksumverify" is "1" and "checksum" is present, "create_close"
will not return until it has verified the checksum.

0 comments on commit 4937ade

Please sign in to comment.