.

bigfile/file_zodb.py

@@ -78,6 +78,8 @@ done by kernel, where we cannot get callback on a page-dirtying, it is more
 natural to also use "2" here.
 """
 
+# FIXME ^^^ doc is horrible - add top-level up->down overview.
+
 from wendelin.bigfile import BigFile, WRITEOUT_STORE, WRITEOUT_MARKSTORED
 from wendelin import wcfs   # XXX -> wendelin.bigfile.wcfs ?
 from wendelin.lib.mem import bzero, memcpy
@@ -456,7 +458,8 @@ class LivePersistent(Persistent):
 
     # NOTE _p_invalidate() is triggered on invalidations. We do not override it.
 
-
+# ZBigFile implements BigFile backend with data stored in ZODB.
+#
 # NOTE Can't inherit from Persistent and BigFile at the same time - both are C
 # types and their layout conflict. Persistent must be here for object to be
 # tracked -> BigFile is moved to a data member (the same way and for the same
@@ -545,7 +548,8 @@ class ZBigFile(LivePersistent):
 
 
 
-    # bigfile-like
+    # fileh_open is bigfile-like method that creates new file-handle object
+    # that is given to user for mmap.
     #
     # _use_wcfs is internal option and controls whether to use wcfs to access
     # ZBigFile data:
@@ -610,6 +614,8 @@ Connection.open = Connection_open
 
 # BigFileH wrapper that also acts as DataManager proxying changes back to ZODB
 # objects at two-phase-commit (TPC) level.
+# XXX and ZODB -> virtmem invalidation.
+# XXX split into _ZBigFileH + _ZSync ?
 #
 # NOTE several fileh can be opened for ZBigFile - and this does not
 #      conflict with the way ZODB organises its work - just for fileh