nodefs: more method documentation

nodefs/README.md

@@ -85,3 +85,4 @@ or
 
    * Merge Fsync/FsyncDir?
  
+   * OnMount in Operations or in Options? Or argument to NewNodeFS ?

nodefs/api.go

@@ -67,8 +67,8 @@ func InodeOf(node Operations) *Inode {
 	return node.inode()
 }
 
-// Operations is the interface that implements the filesystem.  Each
-// Operations instance must embed DefaultNode.
+// Operations is the interface that implements the filesystem inode.
+// Each Operations instance must embed DefaultNode.
 type Operations interface {
 	// setInode and inode are used by nodefs internally to link Inode to a Node.
 	//
@@ -293,7 +293,6 @@ type FileHandle interface {
 
 // Options sets options for the entire filesystem
 type Options struct {
-
 	// Debug toggles debug output
 	Debug bool
 

nodefs/dirstream_linux.go

@@ -17,6 +17,7 @@ type loopbackDirStream struct {
 	fd   int
 }
 
+// NewLoopbackDirStream open a directory for reading as a DirStream
 func NewLoopbackDirStream(name string) (DirStream, fuse.Status) {
 	fd, err := syscall.Open(name, syscall.O_DIRECTORY, 0755)
 	if err != nil {

nodefs/files.go

@@ -14,11 +14,12 @@ import (
 	"github.com/hanwen/go-fuse/fuse"
 )
 
-func newLoopbackFile(fd int) *loopbackFile {
+// NewLoopbackFile creates a FileHandle out of a file descriptor. All
+// operations are implemented.
+func NewLoopbackFile(fd int) FileHandle {
 	return &loopbackFile{fd: fd}
 }
 
-// loopbackFile delegates all operations back to an underlying file.
 type loopbackFile struct {
 	fd int
 

nodefs/loopback.go

@@ -95,7 +95,6 @@ func (n *loopbackNode) Mknod(ctx context.Context, name string, mode, rdev uint32
 }
 
 func (n *loopbackNode) Mkdir(ctx context.Context, name string, mode uint32, out *fuse.EntryOut) (*Inode, fuse.Status) {
-	// NOSUBMIT what about umask
 	p := filepath.Join(n.path(), name)
 	err := os.Mkdir(p, os.FileMode(mode))
 	if err != nil {
@@ -172,7 +171,7 @@ func (n *loopbackNode) Create(ctx context.Context, name string, flags uint32, mo
 
 	node := n.rootNode.newLoopbackNode()
 	ch := n.inode().NewInode(node, uint32(st.Mode), idFromStat(&st))
-	lf := newLoopbackFile(fd)
+	lf := NewLoopbackFile(fd)
 	return ch, lf, 0, fuse.OK
 }
 
@@ -236,7 +235,7 @@ func (n *loopbackNode) Open(ctx context.Context, flags uint32) (fh FileHandle, f
 	if err != nil {
 		return nil, 0, fuse.ToStatus(err)
 	}
-	lf := newLoopbackFile(f)
+	lf := NewLoopbackFile(f)
 	return lf, 0, fuse.OK
 }