.

wcfs/internal/_wcfs.pxd

@@ -21,7 +21,11 @@
 # cython: language_level=2
 # distutils: language=c++
 
-# XXX doc
+# Package _wcfs provides Python-wrappers for C++ wcfs client package.
+#
+# It wraps WCFS/Conn/FileH/Mapping and WatchLink to help wcfs_test.py unit-test
+# WCFS base-layer mmap functionality. At functional level WCFS client (and especially
+# pinner) is verified when running wendelin.core array tests in wcfs mode.
 
 from golang cimport chan, structZ, string, error, refptr
 from golang cimport context
@@ -44,6 +48,7 @@ cdef extern from "wcfs/internal/wcfs_misc.h" namespace "wcfs" nogil:
     const Tid TidHead
 
 
+# pyx/nogil description for C++ classes
 cdef extern from "wcfs/internal/wcfs_watchlink.h" namespace "wcfs" nogil:
     cppclass _WatchLink:
         error close()

wcfs/internal/_wcfs.pyx

@@ -22,11 +22,8 @@
 # cython: auto_pickle=False
 # distutils: language=c++
 
-# Package _wcfs.pyx provides Python-wrappers around WatchLink and WCFS pinner
-# that are used in wcfs_test.py to verify WCFS base-layer mmap functionality.
-#
-# At functional level WCFS pinner is verified when running wendelin.core array
-# tests in wcfs mode.
+# Package _wcfs provides Python-wrappers for C++ wcfs client package.
+# See _wcfs.pxd for package overview.
 
 from golang cimport pychan, nil
 from golang import context as pycontext

wcfs/internal/wcfs.cpp

@@ -297,6 +297,8 @@ pair<FileH, error> _Conn::open(zodb::Oid foid) {
 }
 
 // mmap creates file mapping representing file[blk_start +blk_len) data as of wconn.at database state.
+//
+// If vma != nil, created mapping is associated with that vma of user-space virtual memory manager.
 pair<Mapping, error> _FileH::mmap(int64_t blk_start, int64_t blk_len, VMA *vma) {
     _FileH& f = *this;
     // XXX err ctx