From: Brian Warner <warner@allmydata.com>
Date: Sat, 27 Jan 2007 00:31:24 +0000 (-0700)
Subject: fix some of the filetree/workqueue interface definitions
X-Git-Tag: tahoe_v0.1.0-0-UNSTABLE~310
X-Git-Url: https://git.rkrishnan.org/specifications/%5B/%5D%20/uri?a=commitdiff_plain;h=e4870a432c43c26f5f85e979d1ceb661b19d99bb;p=tahoe-lafs%2Ftahoe-lafs.git

fix some of the filetree/workqueue interface definitions
---

diff --git a/src/allmydata/filetree/interfaces.py b/src/allmydata/filetree/interfaces.py
index 700c2046..4ce08659 100644
--- a/src/allmydata/filetree/interfaces.py
+++ b/src/allmydata/filetree/interfaces.py
@@ -181,7 +181,7 @@ class ISubTree(Interface):
         """Perform whatever work is necessary to record this subtree to
         persistent storage.
 
-        This returns an Inode, or a Deferred that fires (with an INode) when
+        This returns an INode, or a Deferred that fires (with an INode) when
         the subtree has been persisted.
 
         For directory subtrees, this will cause the subtree to serialize
diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index 82fa569e..08a7ce13 100644
--- a/src/allmydata/interfaces.py
+++ b/src/allmydata/interfaces.py
@@ -338,18 +338,18 @@ class IWorkQueue(Interface):
                            new_subtree_boxname=None):
         """When executed, this step retrieves the subtree specified by
         'subtree_node', pulls a node specification out of 'new_node_boxname',
-        then modifies it such that a subtree-relative 'localpath' points to
-        the new node. It then serializes the subtree in its new form, and
+        then modifies the subtree such that a subtree-relative 'localpath'
+        points to the new node. If 'new_node_boxname' is None, this deletes
+        the given path. It then serializes the subtree in its new form, and
         optionally puts a node that describes the new subtree in
-        'new_node_boxname'. If 'new_node_boxname' is None, this deletes the
-        given path.
+        'new_subtree_boxname' for use by another add_modify_subtree step.
 
         The idea is that 'subtree_node' will refer a CHKDirectorySubTree, and
         'new_node_boxname' will contain the CHKFileNode that points to a
         newly-uploaded file. When the CHKDirectorySubTree is modified, it
         acquires a new URI, which will be stuffed (in the form of a
-        CHKDirectorySubTreeNode) into 'new_subtree_boxname'. A following step
-        would then read from 'new_subtree_boxname' and modify some other
+        CHKDirectorySubTreeNode) into 'new_subtree_boxname'. A subsequent
+        step would then read from 'new_subtree_boxname' and modify some other
         subtree with the contents.
 
         If 'subtree_node' refers to a redirection subtree like