From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Sat, 10 Jan 2009 21:56:01 +0000 (-0700)
Subject: trivial: minor changes to in-line comments -- mark plaintext-hash-tree as obsolete
X-Git-Tag: allmydata-tahoe-1.3.0~211
X-Git-Url: https://git.rkrishnan.org/specifications/(%5B%5E?a=commitdiff_plain;h=b496eba0721137ce9f02c5bd1b26ba1e2cf954a3;p=tahoe-lafs%2Ftahoe-lafs.git

trivial: minor changes to in-line comments -- mark plaintext-hash-tree as obsolete
---

diff --git a/src/allmydata/immutable/upload.py b/src/allmydata/immutable/upload.py
index 41b338e3..5c3c759a 100644
--- a/src/allmydata/immutable/upload.py
+++ b/src/allmydata/immutable/upload.py
@@ -683,7 +683,7 @@ class CHKUploader:
         return d
 
     def abort(self):
-        """Call this is the upload must be abandoned before it completes.
+        """Call this if the upload must be abandoned before it completes.
         This will tell the shareholders to delete their partial shares. I
         return a Deferred that fires when these messages have been acked."""
         if not self._encoder:
diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index 98553ab1..18b30071 100644
--- a/src/allmydata/interfaces.py
+++ b/src/allmydata/interfaces.py
@@ -1330,7 +1330,7 @@ class IEncryptedUploadable(Interface):
         plaintext hashes, but don't need the redundant encrypted data)."""
 
     def get_plaintext_hashtree_leaves(first, last, num_segments):
-        """Get the leaf nodes of a merkle hash tree over the plaintext
+        """OBSOLETE; Get the leaf nodes of a merkle hash tree over the plaintext
         segments, i.e. get the tagged hashes of the given segments. The
         segment size is expected to be generated by the IEncryptedUploadable
         before any plaintext is read or ciphertext produced, so that the
@@ -1350,7 +1350,7 @@ class IEncryptedUploadable(Interface):
         """
 
     def get_plaintext_hash():
-        """Get the hash of the whole plaintext.
+        """OBSOLETE; Get the hash of the whole plaintext.
 
         This returns a Deferred which fires with a tagged SHA-256 hash of the
         whole plaintext, obtained from hashutil.plaintext_hash(data).