[DOC-FIX] netfs.h

[Neal H Walfield]

Several spelling mistakes and two important notes (netfs_attempt_lookup
and netfs_nref).

-Neal

Index: ChangeLog
===================================================================
RCS file: /cvs/hurd/libnetfs/ChangeLog,v
retrieving revision 1.49
diff -u -r1.49 ChangeLog
--- ChangeLog   2000/12/30 20:08:31     1.49
+++ ChangeLog   2001/01/15 03:31:31
@@ -1,3 +1,7 @@
+2001-01-14  Neal H Walfield   <neal@cs.uml.edu>
+
+       * netfs.h: Documentation fixes.
+
 2000-12-30  Marcus Brinkmann  <marcus@gnu.org>
 
        * netfs.h: Merge Neals words into documentation of netfs_nput,
Index: netfs.h
===================================================================
RCS file: /cvs/hurd/libnetfs/netfs.h,v
retrieving revision 1.25
diff -u -r1.25 netfs.h
--- netfs.h     2000/12/30 20:08:31     1.25
+++ netfs.h     2001/01/15 03:31:33
@@ -179,8 +179,8 @@
 /* The user must define this function.  Lookup NAME in DIR (which is
    locked) for USER; set *NP to the found name upon return.  If the
    name was not found, then return ENOENT.  On any error, clear *NP.
-   (*NP, if found, should be locked, this call should unlock DIR no
-   matter what.)  */
+   (*NP, if found, should be locked and a reference to it generated.
+   This call should unlock DIR no matter what.)  */
 error_t netfs_attempt_lookup (struct iouser *user, struct node *dir, 
                              char *name, struct node **np);
 
@@ -249,7 +249,7 @@
 
 /* The user must define this function.  Write to the locked file NP
    for user CRED starting at OFSET and continuing for up to *LEN bytes
-   from DATA.  Set *LEN to the amount seccessfully written upon
+   from DATA.  Set *LEN to the amount successfully written upon
    return.  */
 error_t netfs_attempt_write (struct iouser *cred, struct node *np,
                             off_t offset, size_t *len, void *data);
@@ -326,8 +326,8 @@
    If an error occurs, NULL is returned.  */
 struct node *netfs_make_node (struct netnode *);
 
-/* When ever node->references is to be touched, this lock must be
-   held.  Cf. netfs_nrele, netfs_nput, netfs_ref and netfs_drop_node.  */
+/* Whenever node->references is to be touched, this lock must be
+   held.  Cf. netfs_nrele, netfs_nput, netfs_nref and netfs_drop_node.  */
 extern spin_lock_t netfs_node_refcnt_lock;
 
 /* Normally called in main.  This function sets up some of the netfs
@@ -350,11 +350,11 @@
 /* Create and return a new peropen structure on node NP with open
    flags FLAGS.  The initial values for the root_parent, shadow_root,
    and shadow_root_parent fields are copied from CONTEXT if it's
-   non-zero, otherwise zerod.  */
+   non-zero, otherwise zeroed.  */
 struct peropen *netfs_make_peropen (struct node *, int,
                                    struct peropen *context);
 
-/* Add a reference to node NP, which must be locked by the caller.  */
+/* Add a reference to node NP (NP does not have to be locked).  */
 void netfs_nref (struct node *np);
 
 /* Releases a node.  Drops a reference to node NP, which must not be
@@ -382,7 +382,7 @@
 int netfs_demuxer (mach_msg_header_t *, mach_msg_header_t *);
 
 /* Called to ask the filesystem to shutdown.  If it returns, an error
-   occured.  FLAGS are passed to fsys_goaway. */
+   occurred.  FLAGS are passed to fsys_goaway. */
 error_t netfs_shutdown (int flags);
 
 extern struct port_class *netfs_protid_class;

pgp6dwhtbGQWu.pgp
Description: PGP signature