Subject: misc/13133: Various and sundry miscfs typos.
To: None <gnats-bugs@gnats.netbsd.org>
From: None <msanders@confusion.net>
List: netbsd-bugs
Date: 06/07/2001 02:06:01
>Number:         13133
>Category:       misc
>Synopsis:       There are lots of silly typos in miscfs related files and man pages.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Jun 07 02:05:00 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator:     Michael K. Sanders
>Release:        NetBSD-current 2001/06/03
>Organization:
>Environment:
N/A
>Description:
There are lots of silly typos in miscfs related files and man pages.
>How-To-Repeat:
Examine the files.
>Fix:
Apply the patches below (note that I "fixed" some occurrences of function 
and structure names that were capitalized at the beginning of
sentences, since that doesn't seem correct to me.  If that's
inappropriate, ignore those changes).

Index: genfs/layer.h
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/genfs/layer.h,v
retrieving revision 1.3
diff -u -r1.3 layer.h
--- layer.h	2000/03/30 02:19:16	1.3
+++ layer.h	2001/06/07 08:53:59
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: genfs/layer_extern.h
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/genfs/layer_extern.h,v
retrieving revision 1.3
diff -u -r1.3 layer_extern.h
--- layer_extern.h	2000/03/16 18:08:24	1.3
+++ layer_extern.h	2001/06/07 08:53:59
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: genfs/layer_subr.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/genfs/layer_subr.c,v
retrieving revision 1.7
diff -u -r1.7 layer_subr.c
--- layer_subr.c	2000/11/27 08:39:45	1.7
+++ layer_subr.c	2001/06/07 08:53:59
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: genfs/layer_vfsops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/genfs/layer_vfsops.c,v
retrieving revision 1.2
diff -u -r1.2 layer_vfsops.c
--- layer_vfsops.c	2000/03/13 23:52:40	1.2
+++ layer_vfsops.c	2001/06/07 08:53:59
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: genfs/layer_vnops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/genfs/layer_vnops.c,v
retrieving revision 1.5
diff -u -r1.5 layer_vnops.c
--- layer_vnops.c	2000/12/21 03:51:02	1.5
+++ layer_vnops.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: nullfs/null.h
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/nullfs/null.h,v
retrieving revision 1.11
diff -u -r1.11 null.h
--- null.h	2000/03/13 23:52:40	1.11
+++ null.h	2001/06/07 08:54:00
@@ -4,8 +4,8 @@
  * Copyright (c) 1999 National Aeronautics & Space Administration
  * All rights reserved.
  *
- * This software was written by William Studnemund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * This software was written by William Studenmund of the
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: nullfs/null_vfsops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/nullfs/null_vfsops.c,v
retrieving revision 1.29
diff -u -r1.29 null_vfsops.c
--- null_vfsops.c	2001/01/22 12:17:38	1.29
+++ null_vfsops.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
Index: nullfs/null_vnops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/nullfs/null_vnops.c,v
retrieving revision 1.18
diff -u -r1.18 null_vnops.c
--- null_vnops.c	2001/01/22 12:17:38	1.18
+++ null_vnops.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -85,25 +85,25 @@
  * name space under a new name.  In this respect, it is
  * similar to the loopback file system.  It differs from
  * the loopback fs in two respects:  it is implemented using
- * a stackable layers techniques, and it's "null-node"s stack above
+ * a stackable layers technique, and its "null-nodes" stack above
  * all lower-layer vnodes, not just over directory vnodes.
  *
  * The null layer has two purposes.  First, it serves as a demonstration
- * of layering by proving a layer which does nothing.  (It actually
+ * of layering by providing a layer which does nothing (it actually
  * does everything the loopback file system does, which is slightly
- * more than nothing.)  Second, the null layer can serve as a prototype
+ * more than nothing).  Second, the null layer can serve as a prototype
  * layer.  Since it provides all necessary layer framework,
- * new file system layers can be created very easily be starting
+ * new file system layers can be created very easily by starting
  * with a null layer.
  *
- * The remainder of this man page examines the null layer as a basis
+ * The remainder of this comment examines the null layer as a basis
  * for constructing new layers.
  *
  *
  * INSTANTIATING NEW NULL LAYERS
  *
  * New null layers are created with mount_null(8).
- * Mount_null(8) takes two arguments, the pathname
+ * mount_null(8) takes two arguments, the pathname
  * of the lower vfs (target-pn) and the pathname where the null
  * layer will appear in the namespace (alias-pn).  After
  * the null layer is put into place, the contents
@@ -115,24 +115,24 @@
  * The null layer is the minimum file system layer,
  * simply bypassing all possible operations to the lower layer
  * for processing there.  The majority of its activity centers
- * on the bypass routine, though which nearly all vnode operations
+ * on the bypass routine, through which nearly all vnode operations
  * pass.
  *
  * The bypass routine accepts arbitrary vnode operations for
- * handling by the lower layer.  It begins by examing vnode
+ * handling by the lower layer.  It begins by examining vnode
  * operation arguments and replacing any null-nodes by their
- * lower-layer equivlants.  It then invokes the operation
+ * lower-layer equivalents.  It then invokes the operation
  * on the lower layer.  Finally, it replaces the null-nodes
- * in the arguments and, if a vnode is return by the operation,
+ * in the arguments and, if a vnode is returned by the operation,
  * stacks a null-node on top of the returned vnode.
  *
  * Although bypass handles most operations, vop_getattr, vop_lock,
  * vop_unlock, vop_inactive, vop_reclaim, and vop_print are not
- * bypassed. Vop_getattr must change the fsid being returned.
- * Vop_lock and vop_unlock must handle any locking for the
+ * bypassed. vop_getattr must change the fsid being returned.
+ * vop_lock and vop_unlock must handle any locking for the
  * current vnode as well as pass the lock request down.
- * Vop_inactive and vop_reclaim are not bypassed so that
- * they can handle freeing null-layer specific data. Vop_print
+ * vop_inactive and vop_reclaim are not bypassed so that
+ * they can handle freeing null-layer specific data. vop_print
  * is not bypassed to avoid excessive debugging information.
  * Also, certain vnode operations change the locking state within
  * the operation (create, mknod, remove, link, rename, mkdir, rmdir,
@@ -146,7 +146,7 @@
  * INSTANTIATING VNODE STACKS
  *
  * Mounting associates the null layer with a lower layer,
- * effect stacking two VFSes.  Vnode stacks are instead
+ * in effect stacking two VFSes.  vnode stacks are instead
  * created on demand as files are accessed.
  *
  * The initial mount creates a single vnode stack for the
@@ -154,7 +154,7 @@
  * are created as a result of vnode operations on
  * this or other null vnode stacks.
  *
- * New vnode stacks come into existance as a result of
+ * New vnode stacks come into existence as a result of
  * an operation which returns a vnode.  
  * The bypass routine stacks a null-node above the new
  * vnode before returning it to the caller.
@@ -166,7 +166,7 @@
  * Now consider opening "sys".  A vop_lookup would be
  * done on the root null-node.  This operation would bypass through
  * to the lower layer which would return a vnode representing 
- * the UFS "sys".  Null_bypass then builds a null-node
+ * the UFS "sys".  null_bypass then builds a null-node
  * aliasing the UFS "sys" and returns this to the caller.
  * Later operations on the null-node "sys" will repeat this
  * process when constructing other vnode stacks.
@@ -176,7 +176,7 @@
  *
  * One of the easiest ways to construct new file system layers is to make
  * a copy of the null layer, rename all files and variables, and
- * then begin modifing the copy.  Sed can be used to easily rename
+ * then begin modifying the copy.  sed(1) can be used to easily rename
  * all variables.
  *
  * The umap layer is an example of a layer descended from the 
@@ -190,7 +190,7 @@
  * is appropriate in different situations.  In both cases,
  * it is the responsibility of the aliasing layer to make
  * the operation arguments "correct" for the lower layer
- * by mapping an vnode arguments to the lower layer.
+ * by mapping any vnode arguments to the lower layer.
  *
  * The first approach is to call the aliasing layer's bypass routine.
  * This method is most suitable when you wish to invoke the operation
@@ -198,11 +198,11 @@
  * that the bypass routine already must do argument mapping.
  * An example of this is null_getattrs in the null layer.
  *
- * A second approach is to directly invoked vnode operations on
+ * A second approach is to directly invoke vnode operations on
  * the lower layer with the VOP_OPERATIONNAME interface.
  * The advantage of this method is that it is easy to invoke
  * arbitrary operations on the lower layer.  The disadvantage
- * is that vnodes arguments must be manualy mapped.
+ * is that vnode arguments must be manualy mapped.
  *
  */
 
Index: overlay/overlay.h
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/overlay/overlay.h,v
retrieving revision 1.2
diff -u -r1.2 overlay.h
--- overlay.h	2000/03/13 23:52:41	1.2
+++ overlay.h	2001/06/07 08:54:00
@@ -4,8 +4,8 @@
  * Copyright (c) 1999 National Aeronautics & Space Administration
  * All rights reserved.
  *
- * This software was written by William Studnemund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * This software was written by William Studenmund of the
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -78,7 +78,7 @@
 	struct	layer_args	la;	/* generic layerfs args */
 };
 /*
- * We leave ova_target for two reasons. One, We can tell the difference
+ * We leave ova_target for two reasons. One, we can tell the difference
  * between a mount_overlay -u and a call from mountd as the former will
  * pass a pointer to a string while the latter will pass NULL. Two,
  * filesystems based on the overlay layer might have use for it.
Index: overlay/overlay_vfsops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/overlay/overlay_vfsops.c,v
retrieving revision 1.6
diff -u -r1.6 overlay_vfsops.c
--- overlay_vfsops.c	2001/01/22 12:17:39	1.6
+++ overlay_vfsops.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -73,8 +73,8 @@
  */
 
 /*
- * Null Layer
- * (See null_vnops.c for a description of what this does.)
+ * Overlay Layer
+ * (See overlay_vnops.c for a description of what this does.)
  */
 
 #include <sys/param.h>
Index: overlay/overlay_vnops.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/overlay/overlay_vnops.c,v
retrieving revision 1.3
diff -u -r1.3 overlay_vnops.c
--- overlay_vnops.c	2001/01/22 12:17:39	1.3
+++ overlay_vnops.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -82,11 +82,11 @@
  * (See mount_overlay(8) for more information.)
  *
  * The overlay layer has two purposes.  First, it serves as a demonstration
- * of layering by proving a layer which really does nothing.  (the null
- * layer makes the underlying files appear elsewhere in the file hierarchy)
+ * of layering by providing a layer which really does nothing (the null
+ * layer makes the underlying files appear elsewhere in the file hierarchy).
  * Second, the overlay layer can serve as a prototype layer. Since it
  * provides all necessary layer framework, new file system layers can be
- * created very easily be starting with an overlay layer.
+ * created very easily by starting with an overlay layer.
  *
  * The remainder of this comment examines the overlay layer as a basis
  * for constructing new layers.
@@ -94,11 +94,11 @@
  *
  * INSTANTIATING NEW OVERLAY LAYERS
  *
- * New null layers are created with mount_overlay(8).
- * Mount_overlay(8) takes two arguments, an ignored string
+ * New overlay layers are created with mount_overlay(8).
+ * mount_overlay(8) takes two arguments, an ignored string
  * and the pathname which the overlay will mount over. After
  * the overlay layer is put into place, all access to the mount
- * point path will proceede through the overlay layer.
+ * point path will proceed through the overlay layer.
  *
  *
  * OPERATION OF AN OVERLAY LAYER
@@ -111,14 +111,14 @@
  *
  * One of the easiest ways to construct new file system layers is to make
  * a copy of either the null layer or the overlay layer, rename all files
- * and variables, and then begin modifing the copy.  Sed can be used to
+ * and variables, and then begin modifying the copy.  sed(1) can be used to
  * easily rename all variables.
  *
  * The choice between using a null and an overlay layer depends on
  * the desirability of retaining access to the underlying filestore.
  * For instance, the umap filesystem presents both a uid-translated and an
- * untranslaged view of the underlying files, and so it is based off of
- * the null layer. However a layer implimenting Access Controll Lists
+ * untranslated view of the underlying files, and so it is based off of
+ * the null layer. However a layer implementing Access Control Lists
  * might prefer to block access to the underlying filestore, for which
  * the overlay layer is a better basis.
  *
Index: umapfs/umap_subr.c
===================================================================
RCS file: /cvsroot/syssrc/sys/miscfs/umapfs/umap_subr.c,v
retrieving revision 1.16
diff -u -r1.16 umap_subr.c
--- umap_subr.c	2000/03/13 23:52:41	1.16
+++ umap_subr.c	2001/06/07 08:54:00
@@ -5,7 +5,7 @@
  * All rights reserved.
  *
  * This software was written by William Studenmund of the
- * Numerical Aerospace Similation Facility, NASA Ames Research Center.
+ * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
? mount_null/mount_null
? mount_null/mount_null.cat8
Index: mount_null/mount_null.8
===================================================================
RCS file: /cvsroot/basesrc/sbin/mount_null/mount_null.8,v
retrieving revision 1.11
diff -u -r1.11 mount_null.8
--- mount_null.8	2001/04/11 15:17:51	1.11
+++ mount_null.8	2001/06/07 09:01:37
@@ -71,7 +71,7 @@
 .Nm
 filesystem differs from a traditional
 loopback file system in two respects: it is implemented using
-a stackable layers techniques, and its 
+a stackable layers technique, and its 
 .Do
 null-nodes
 .Dc
@@ -90,11 +90,11 @@
 .El
 .Pp
 The null layer has two purposes.
-First, it serves as a demonstration of layering by proving a layer
+First, it serves as a demonstration of layering by providing a layer
 which does nothing.
 Second, the null layer can serve as a prototype layer.
 Since it provides all necessary layer framework,
-new file system layers can be created very easily be starting
+new file system layers can be created very easily by starting
 with a null layer.
 .Pp
 The remainder of this man page examines the null layer as a basis
@@ -134,19 +134,19 @@
 and
 .Em vop_print
 are not bypassed.
-.Em Vop_getattr
+.Em vop_getattr
 must change the fsid being returned.
-.Em Vop_inactive
+.Em vop_inactive
 and vop_reclaim are not bypassed so that
 they can handle freeing null-layer specific data.
-.Em Vop_print
+.Em vop_print
 is not bypassed to avoid excessive debugging
 information.
 .\"
 .\"
 .Sh INSTANTIATING VNODE STACKS
 Mounting associates the null layer with a lower layer,
-in effect stacking two VFSes.  Vnode stacks are instead
+in effect stacking two VFSes.  vnode stacks are instead
 created on demand as files are accessed.
 .Pp
 The initial mount creates a single vnode stack for the
@@ -174,7 +174,7 @@
 to the lower layer which would return a vnode representing 
 the UFS 
 .Pa sys .
-Null_bypass then builds a null-node
+null_bypass then builds a null-node
 aliasing the UFS 
 .Pa sys
 and returns this to the caller.
@@ -187,7 +187,9 @@
 .Sh CREATING OTHER FILE SYSTEM LAYERS
 One of the easiest ways to construct new file system layers is to make
 a copy of the null layer, rename all files and variables, and
-then begin modifying the copy.  Sed can be used to easily rename
+then begin modifying the copy.
+.Xr sed 1
+can be used to easily rename
 all variables.
 .Pp
 The umap layer is an example of a layer descended from the 
@@ -200,23 +202,23 @@
 is appropriate in different situations.  In both cases,
 it is the responsibility of the aliasing layer to make
 the operation arguments "correct" for the lower layer
-by mapping an vnode arguments to the lower layer.
+by mapping any vnode arguments to the lower layer.
 .Pp
 The first approach is to call the aliasing layer's bypass routine.
 This method is most suitable when you wish to invoke the operation
 currently being handled on the lower layer.  It has the advantage
-the bypass routine already must do argument mapping.
+that the bypass routine already must do argument mapping.
 An example of this is 
 .Em null_getattrs
 in the null layer.
 .Pp
-A second approach is to directly invoked vnode operations on
+A second approach is to directly invoke vnode operations on
 the lower layer with the
 .Em VOP_OPERATIONNAME
 interface.
 The advantage of this method is that it is easy to invoke
 arbitrary operations on the lower layer.  The disadvantage
-is that vnodes arguments must be manually mapped.
+is that vnode arguments must be manually mapped.
 .\"
 .\"
 .Sh SEE ALSO
Index: mount_overlay/mount_overlay.8
===================================================================
RCS file: /cvsroot/basesrc/sbin/mount_overlay/mount_overlay.8,v
retrieving revision 1.3
diff -u -r1.3 mount_overlay.8
--- mount_overlay.8	2000/07/30 10:41:29	1.3
+++ mount_overlay.8	2001/06/07 09:01:41
@@ -74,7 +74,7 @@
 Second, the overlay layer can serve as a prototype layer.
 Since it provides all necessary layer framework,
 new file system layers which need to block access to the overlayed
-file system can be created very easily be starting
+file system can be created very easily by starting
 with an overlay layer.
 .Pp
 The internal operation of the overlay layer is identical to that of the
>Release-Note:
>Audit-Trail:
>Unformatted: