.

setup.py

@@ -265,7 +265,7 @@ setup(
                     language = 'c'),
 
                    DSO('wendelin.wcfs.internal.libwcfs',
-                    ['wcfs/internal/wcfs_virtmem.cpp',
+                    ['wcfs/internal/wcfs.cpp',
                      'wcfs/internal/wcfs_watchlink.cpp',
                      'wcfs/internal/wcfs_misc.cpp'],
                     dsos = ['wendelin.bigfile.libvirtmem'])],

wcfs/internal/wcfs_virtmem.cpp → wcfs/internal/wcfs.cpp

@@ -17,11 +17,10 @@
 // See COPYING file for full licensing terms.
 // See https://www.nexedi.com/licensing for rationale and options.
 
-// wcfs_virtmem provides wcfs client integrated with user-spce virtmem layer.
-//
-// XXX provides isolated view.
+// Package wcfs provides WCFS client integrated with user-space virtual memory manager.
+// See wcfs.h for package overview.
 
-// XXX wcfs_virtmem organization.
+// wcfs client organization.
 //
 // - need to maintain pinner map registry
 //

wcfs/internal/wcfs.h

@@ -17,7 +17,16 @@
 // See COPYING file for full licensing terms.
 // See https://www.nexedi.com/licensing for rationale and options.
 
-// XXX doc
+// Package wcfs provides WCFS client integrated with user-space virtual memory manager.
+//
+//  - `WCFS` represents filesystem-level connection to wcfs server.
+//  - `Conn` represents logical connection that provides view of data on wcfs
+//    filesystem as of particular database state.
+//  - `FileH` represent isolated file view under Conn.
+//  - `Mapping` represents one memory mapping of FileH.
+//
+// XXX text
+// XXX provides isolated view.
 
 #ifndef _NXD_WCFS_H_
 #define _NXD_WCFS_H_
@@ -148,7 +157,7 @@ public:
     pair<Mapping, error> mmap(int64_t blk_start, int64_t blk_len, VMA *vma=nil);
 };
 
-// Mapping represents one mapping of FileH.
+// Mapping represents one memory mapping of FileH.
 typedef refptr<struct _Mapping> Mapping;
 struct _Mapping : object {
     FileH   fileh;