[Zodb-checkins] SVN: ZODB/trunk/src/ZODB/FileStorage/ Merge _data_find comment repair from 3.3 branch.

[Tim Peters]

Log message for revision 25894:
Merge _data_find comment repair from 3.3 branch.


-=-
Modified: ZODB/trunk/src/ZODB/FileStorage/FileStorage.py
===================================================================
--- ZODB/trunk/src/ZODB/FileStorage/FileStorage.py	2004-06-17 17:40:56 UTC (rev 25893)
+++ ZODB/trunk/src/ZODB/FileStorage/FileStorage.py	2004-06-17 17:43:13 UTC (rev 25894)
@@ -681,9 +681,18 @@
             self._lock_release()
 
     def _data_find(self, tpos, oid, data):
-        # Return backpointer to oid in data record for in transaction at tpos.
-        # It should contain a pickle identical to data. Returns 0 on failure.
-        # Must call with lock held.
+        # Return backpointer for oid.  Must call with the lock held.
+        # This is a file offset to oid's data record if found, else 0.
+        # The data records in the transaction at tpos are searched for oid.
+        # If a data record for oid isn't found, returns 0.
+        # Else if oid's data record contains a backpointer, that
+        # backpointer is returned.
+        # Else oid's data record contains the data, and the file offset of
+        # oid's data record is returned.  This data record should contain
+        # a pickle identical to the 'data' argument.
+        # XXX If the length of the stored data doesn't match len(data),
+        # XXX an exception is raised.  If the lengths match but the data
+        # XXX isn't the same, 0 is returned.  Why the discrepancy?
         self._file.seek(tpos)
         h = self._file.read(TRANS_HDR_LEN)
         tid, tl, status, ul, dl, el = struct.unpack(TRANS_HDR, h)

Modified: ZODB/trunk/src/ZODB/FileStorage/fspack.py
===================================================================
--- ZODB/trunk/src/ZODB/FileStorage/fspack.py	2004-06-17 17:40:56 UTC (rev 25893)
+++ ZODB/trunk/src/ZODB/FileStorage/fspack.py	2004-06-17 17:43:13 UTC (rev 25894)
@@ -73,9 +73,18 @@
         raise UndoError(None, "Invalid transaction id")
 
     def _data_find(self, tpos, oid, data):
-        # Return backpointer to oid in data record for in transaction at tpos.
-        # It should contain a pickle identical to data. Returns 0 on failure.
-        # Must call with lock held.
+        # Return backpointer for oid.  Must call with the lock held.
+        # This is a file offset to oid's data record if found, else 0.
+        # The data records in the transaction at tpos are searched for oid.
+        # If a data record for oid isn't found, returns 0.
+        # Else if oid's data record contains a backpointer, that
+        # backpointer is returned.
+        # Else oid's data record contains the data, and the file offset of
+        # oid's data record is returned.  This data record should contain
+        # a pickle identical to the 'data' argument.
+        # XXX If the length of the stored data doesn't match len(data),
+        # XXX an exception is raised.  If the lengths match but the data
+        # XXX isn't the same, 0 is returned.  Why the discrepancy?
         h = self._read_txn_header(tpos)
         tend = tpos + h.tlen
         pos = self._file.tell()