Module Name: src
Committed By: wiz
Date: Wed Apr 18 14:24:26 UTC 2012
Modified Files:
src/lib/libpuffs: puffs.3 puffs_ops.3
Log Message:
Bump date for previous.
New sentence, new line; remove trailing whitespace; fix typos;
punctuation nits.
To generate a diff of this commit:
cvs rdiff -u -r1.52 -r1.53 src/lib/libpuffs/puffs.3
cvs rdiff -u -r1.30 -r1.31 src/lib/libpuffs/puffs_ops.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libpuffs/puffs.3
diff -u src/lib/libpuffs/puffs.3:1.52 src/lib/libpuffs/puffs.3:1.53
--- src/lib/libpuffs/puffs.3:1.52 Wed Apr 18 00:57:22 2012
+++ src/lib/libpuffs/puffs.3 Wed Apr 18 14:24:26 2012
@@ -1,4 +1,4 @@
-.\" $NetBSD: puffs.3,v 1.52 2012/04/18 00:57:22 manu Exp $
+.\" $NetBSD: puffs.3,v 1.53 2012/04/18 14:24:26 wiz Exp $
.\"
.\" Copyright (c) 2006, 2007, 2008 Antti Kantee. All rights reserved.
.\"
@@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd April 8, 2012
+.Dd April 18, 2012
.Dt PUFFS 3
.Os
.Sh NAME
@@ -237,22 +237,21 @@ Especially if the file system uses the a
is a good idea to define this flag.
.It Dv PUFFS_KFLAG_CACHE_FS_TTL
Enforce name and attribute caches based on file system-supplied TTL.
-In lookup, create, mknod, mkdir, and symlink, the file system must
-update the node attributes, their TTL, and the node name TTL through
+In lookup, create, mknod, mkdir, and symlink, the file system must
+update the node attributes, their TTL, and the node name TTL through
.Fn puffs_newinfo_setva ,
-.Fn puffs_newinfo_setvattl
+.Fn puffs_newinfo_setvattl ,
and
.Fn puffs_newinfo_setcnttl .
.Pp
-Additionally,
+Additionally,
.Fn puffs_node_getattr_ttl
and
.Fn puffs_node_setattr_ttl
-will be called instead of
+will be called instead of
.Fn puffs_node_getattr
and
.Fn puffs_node_setattr .
-
.It Dv PUFFS_FLAG_OPDUMP
This option makes the framework dump a textual representation of
each operation before executing it.
Index: src/lib/libpuffs/puffs_ops.3
diff -u src/lib/libpuffs/puffs_ops.3:1.30 src/lib/libpuffs/puffs_ops.3:1.31
--- src/lib/libpuffs/puffs_ops.3:1.30 Wed Apr 18 00:57:22 2012
+++ src/lib/libpuffs/puffs_ops.3 Wed Apr 18 14:24:26 2012
@@ -1,4 +1,4 @@
-.\" $NetBSD: puffs_ops.3,v 1.30 2012/04/18 00:57:22 manu Exp $
+.\" $NetBSD: puffs_ops.3,v 1.31 2012/04/18 14:24:26 wiz Exp $
.\"
.\" Copyright (c) 2007 Antti Kantee. All rights reserved.
.\"
@@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd December 13, 2010
+.Dd April 18, 2012
.Dt PUFFS_OPS 3
.Os
.Sh NAME
@@ -290,7 +290,7 @@ Wait for all I/O for complete until retu
Initiate I/O, but do not wait for completion.
.It Dv MNT_LAZY
Synchorize data not synchoronized by the file system syncer,
-i.e. data not written when
+i.e., data not written when
.Fn node_fsync
is called with
.Dv FSYNC_LAZY .
@@ -386,17 +386,17 @@ If the located entry is a block device o
the dev_t for the entry should be set using
.Fn puffs_newinfo_setrdev .
.Pp
-If
+If
.Fn puffs_init
was called with
.Dv PUFFS_KFLAG_CACHE_FS_TTL
-then
+then
.Fn puffs_newinfo_setva ,
.Fn puffs_newinfo_setvattl ,
and
.Fn puffs_newinfo_setcnttl
can be called to specify the new node attributes, cached attributes
-time to live, and cached name timeto live.
+time to live, and cached name time to live.
.Pp
The type of operation is found from
.Va pcn-\*[Gt]pcn_nameiop :
@@ -690,12 +690,12 @@ is a vector for offsets corresponding to
One cookie should be filled out for each directory entry.
The value of the cookie should equal the offset of the
.Em next
-directory entry, i.e. which offset should be passed to readdir for
+directory entry, i.e., which offset should be passed to readdir for
the first entry read to be the entry following the current one.
.Fa ncookies
is the number of slots for cookies in the cookie vector upon entry to
the function and must be set to the amount of cookies stored in the
-vector (i.e. amount of directory entries read) upon exit.
+vector (i.e., amount of directory entries read) upon exit.
There is always enough space in the cookie vector for the maximal number
of entries that will fit into the directory entry buffer.
For filling out the vector, the helper function
@@ -772,7 +772,7 @@ In case the file
.Fa opc
has a link count of zero, it may be safely removed now.
.It Fn puffs_node_abortop "pu" "opc" "pcn"
-In case the operation following lookup (e.g. mkdir or remove) is not
+In case the operation following lookup (e.g., mkdir or remove) is not
executed for some reason, abortop will be issued.
This is useful only for servers which cache state between lookup
and a directory operation and is generally left unimplemented.
@@ -799,7 +799,7 @@ should call the file system inactive met
The node number 1 always means the operation cookie
.Ar opc ,
while the node number 2 can be used to specify the second node argument
-present in some methods, e.g. remove.
+present in some methods, e.g., remove.
.It Fn puffs_newinfo_setcookie pni cookie
Set cookie for node provided by this method to
.Ar cookie .
@@ -827,7 +827,8 @@ and
.Fn fhtovp
producing device type nodes.
.It Fn puffs_newinfo_setva pni vap
-Set the attributes for newly created vnode. This call is valid for
+Set the attributes for newly created vnode.
+This call is valid for
.Fn lookup ,
.Fn create ,
.Fn mkdir ,
@@ -836,12 +837,12 @@ and
.Fn symlink ,
if
.Fn puffs_init
-vas called with
+was called with
.Dv PUFFS_KFLAG_CACHE_FS_TTL
flag set.
.It Fn puffs_newinfo_setvattl pni va_ttl
-Set cached attribute time to live for newly created vnode.
-This call is valid for
+Set cached attribute time to live for newly created vnode.
+This call is valid for
.Fn lookup ,
.Fn create ,
.Fn mkdir ,
@@ -850,11 +851,12 @@ and
.Fn symlink ,
if
.Fn puffs_init
-vas called with
+was called with
.Dv PUFFS_KFLAG_CACHE_FS_TTL
flag set.
.It Fn puffs_newinfo_setcnttl pni cn_ttl
-Set cached name time to live for newly created vnode. This call is valid for
+Set cached name time to live for newly created vnode.
+This call is valid for
.Fn lookup ,
.Fn create ,
.Fn mkdir ,
@@ -863,7 +865,7 @@ and
.Fn symlink ,
if
.Fn puffs_init
-vas called with
+was called with
.Dv PUFFS_KFLAG_CACHE_FS_TTL
flag set.
.El
