From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Sun, 28 Dec 2008 23:59:54 +0000 (-0700)
Subject: doc: sundry amendments to docs and in-line code comments
X-Git-Url: https://git.rkrishnan.org/components/architecture.txt?a=commitdiff_plain;h=872e4fc84d1e426807e412ab4afc7746eeef5075;p=tahoe-lafs%2Ftahoe-lafs.git

doc: sundry amendments to docs and in-line code comments
---

diff --git a/NEWS b/NEWS
index df763f7e..f8d607d1 100644
--- a/NEWS
+++ b/NEWS
@@ -81,7 +81,8 @@ of existing mutable shares).
 This release adds the 'tahoe create-alias' command, which is a combination of
 'tahoe mkdir' and 'tahoe add-alias'. This also allows you to start using a
 new tahoe directory without exposing its URI in the argv list, which is
-publicly visible (through the process table) on most unix systems.
+publicly visible (through the process table) on most unix systems. Thanks to
+Kevin Reid for bringing this issue to our attention.
 
 The single-argument form of "tahoe put" was changed to create an unlinked
 file. I.e. "tahoe put bar.txt" will take the contents of a local "bar.txt"
diff --git a/docs/how_to_make_a_tahoe_release.txt b/docs/how_to_make_a_tahoe_release.txt
index f94d74a8..1624abfe 100644
--- a/docs/how_to_make_a_tahoe_release.txt
+++ b/docs/how_to_make_a_tahoe_release.txt
@@ -8,7 +8,7 @@
 * make sure debs got built and uploaded properly
 * make sure a sumo sdist tarball got built and uploaded properly
 * send out relnotes.txt
- x  + tahoe-announce@lists.allmydata.org, tahoe-dev@lists.allmydata.org, p2p-hackers@lists.zooko.com, lwn@lwn.net, cap-talk@mail.eros-os.org, cryptography@metzdown.com, twisted-python@twistedmatrix.com, fuse-devel@lists.sourceforge.net, duplicity-talk@nongnu.org, news@phoronix.com
+ x  + tahoe-announce@lists.allmydata.org, tahoe-dev@lists.allmydata.org, p2p-hackers@lists.zooko.com, lwn@lwn.net, cap-talk@mail.eros-os.org, cryptography@metzdown.com, twisted-python@twistedmatrix.com, fuse-devel@lists.sourceforge.net, duplicity-talk@nongnu.org, news@phoronix.com, python-list@python.org
 * update Wiki: front page news, news, old news, parade of release notes
 * update "current version" information and make an "announcement of new release" on freshmeat
 * upload to pypi with "make make-version && python ./setup.py sdist upload register"
diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index 2f824935..7a185d91 100644
--- a/src/allmydata/interfaces.py
+++ b/src/allmydata/interfaces.py
@@ -1613,7 +1613,7 @@ class ICheckerResults(Interface):
 
 
     def get_data():
-        """Return a dictionary that describes the state of the file/dir.  Non-distributed LIT
+        """Return a dictionary that describes the state of the file/dir.  LIT
         files always return an empty dictionary. Normal files and directories return a
         dictionary with the following keys (note that these use binary strings rather than
         base32-encoded ones) (also note that for mutable files, these counts are for the 'best'
diff --git a/src/allmydata/test/test_immutable_checker.py b/src/allmydata/test/test_immutable_checker.py
index e743726b..a7e0c4db 100644
--- a/src/allmydata/test/test_immutable_checker.py
+++ b/src/allmydata/test/test_immutable_checker.py
@@ -364,8 +364,7 @@ class Test(ShareManglingMixin, unittest.TestCase):
             d2 = filenode.check(Monitor(), verify=True)
             def _after_check(checkresults):
                 after_check_reads = self._count_reads()
-                # print "delta was ", after_check_reads - before_check_reads
-                self.failIf(after_check_reads - before_check_reads > DELTA_READS)
+                self.failIf(after_check_reads - before_check_reads > DELTA_READS, (after_check_reads, before_check_reads, DELTA_READS))
                 self.failUnless(checkresults.is_healthy())
 
             d2.addCallback(_after_check)
@@ -385,7 +384,6 @@ class Test(ShareManglingMixin, unittest.TestCase):
 
             def _after_check(checkresults):
                 after_check_reads = self._count_reads()
-                # print "delta was ", after_check_reads - before_check_reads
                 self.failIf(after_check_reads - before_check_reads > DELTA_READS)
                 self.failIf(checkresults.is_healthy())
 
diff --git a/src/allmydata/test/test_system.py b/src/allmydata/test/test_system.py
index 7bc51735..ea34f2a4 100644
--- a/src/allmydata/test/test_system.py
+++ b/src/allmydata/test/test_system.py
@@ -2074,7 +2074,7 @@ class DeepCheckWebGood(DeepCheckBase, unittest.TestCase):
 
 
     def check_and_repair_is_healthy(self, cr, n, where, incomplete=False):
-        self.failUnless(ICheckAndRepairResults.providedBy(cr), where)
+        self.failUnless(ICheckAndRepairResults.providedBy(cr), (where, cr))
         self.failUnless(cr.get_pre_repair_results().is_healthy(), where)
         self.check_is_healthy(cr.get_pre_repair_results(), n, where, incomplete)
         self.failUnless(cr.get_post_repair_results().is_healthy(), where)
@@ -2156,8 +2156,7 @@ class DeepCheckWebGood(DeepCheckBase, unittest.TestCase):
         d.addCallback(lambda ign: self.mutable.check(Monitor(), verify=True))
         d.addCallback(self.check_is_healthy, self.mutable, "mutable")
         d.addCallback(lambda ign: self.large.check(Monitor(), verify=True))
-        d.addCallback(self.check_is_healthy, self.large, "large",
-                      incomplete=True)
+        d.addCallback(self.check_is_healthy, self.large, "large", incomplete=True)
         d.addCallback(lambda ign: self.small.check(Monitor(), verify=True))
         d.addCallback(self.failUnlessEqual, None, "small")
         d.addCallback(lambda ign: self.small2.check(Monitor(), verify=True))
@@ -2660,8 +2659,7 @@ class DeepCheckWebBad(DeepCheckBase, unittest.TestCase):
         d = cr.get_data()
         self.failIf(cr.is_healthy(), where)
         self.failIf(cr.is_recoverable(), where)
-        self.failUnless(d["count-shares-good"] < d["count-shares-needed"],
-                        where)
+        self.failUnless(d["count-shares-good"] < d["count-shares-needed"], (d["count-shares-good"], d["count-shares-needed"], where))
         self.failUnlessEqual(d["count-recoverable-versions"], 0, where)
         self.failUnlessEqual(d["count-unrecoverable-versions"], 1, where)
         return cr
@@ -2742,7 +2740,7 @@ class DeepCheckWebBad(DeepCheckBase, unittest.TestCase):
             #self.failUnlessEqual(c["count-objects-unhealthy"], 6)
             self.failUnlessEqual(c["count-objects-healthy"], 5) # todo
             self.failUnlessEqual(c["count-objects-unhealthy"], 4)
-            self.failUnlessEqual(c["count-objects-unrecoverable"], 2)
+            self.failUnlessEqual(c["count-objects-unrecoverable"], 2, str(c))
         d.addCallback(_check2)
 
         return d