From: david-sarah <david-sarah@jacaranda.org>
Date: Tue, 13 Sep 2011 00:28:43 +0000 (-0700)
Subject: interfaces: document that the 'fills-holes-with-zero-bytes' key should be used to... 
X-Git-Tag: allmydata-tahoe-1.9.0a2~36
X-Git-Url: https://git.rkrishnan.org/%5B/%5D%20/uri/flags/architecture.txt?a=commitdiff_plain;h=c10099f982ee08030502297deb7c098797da26be;p=tahoe-lafs%2Ftahoe-lafs.git

interfaces: document that the 'fills-holes-with-zero-bytes' key should be used to detect whether a storage server has that behavior. refs #1528
---

diff --git a/src/allmydata/interfaces.py b/src/allmydata/interfaces.py
index acea3b04..cb456235 100644
--- a/src/allmydata/interfaces.py
+++ b/src/allmydata/interfaces.py
@@ -214,7 +214,10 @@ class RIStorageServer(RemoteInterface):
         between the end of the current data and the beginning of the write
         vector will be filled with zero bytes. In earlier versions the
         contents of this space was unspecified (and might end up containing
-        secrets).
+        secrets). Storage servers with the new zero-filling behavior will
+        advertise a true value for the 'fills-holes-with-zero-bytes' key
+        (under 'http://allmydata.org/tahoe/protocols/storage/v1') in their
+        version information.
 
         Each write vector is accompanied by a 'new_length' argument, which
         can be used to truncate the data. If new_length is not None and it is
@@ -228,12 +231,13 @@ class RIStorageServer(RemoteInterface):
         of Tahoe-LAFS v1.8.3 it no longer works and the new_length is ignored
         in that case.
 
-        If a storage client can rely on a server being of version v1.8.3 or
-        later, it can extend the file efficiently by writing a single zero
-        byte just before the new end-of-file. Otherwise it must explicitly
-        write zeroes to all bytes between the old and new end-of-file. In any
-        case it should avoid sending new_length larger than the size of the
-        data after applying all write vectors.
+        If a storage client knows that the server supports zero-filling, for
+        example from the 'fills-holes-with-zero-bytes' key in its version
+        information, it can extend the file efficiently by writing a single
+        zero byte just before the new end-of-file. Otherwise it must
+        explicitly write zeroes to all bytes between the old and new
+        end-of-file. In any case it should avoid sending new_length larger
+        than the size of the data after applying all write vectors.
 
         The read vector is used to extract data from all known shares,
         *before* any writes have been applied. The same vector is used for