NetBSD-Bugs archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

misc/51611: Minor adjustments to the fileassoc(9) man page



>Number:         51611
>Category:       misc
>Synopsis:       Minor adjustments to the fileassoc(9) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Nov 08 02:35:00 +0000 2016
>Originator:     David H. Gutteridge
>Release:        HEAD
>Organization:
>Environment:
n/a
>Description:
The changes are self-evident from the diff, but just in case there
are any questions, here's what's what.

Content:

I added an xref to veriexec(9), since it's explicitly referred to in
the Examples section, and it has an xref to this man page.

Style:

* Both "data structure" and "data-structure" are used inconsistently,
so I amended to "data structure" everywhere, which is the form found
in other man pages.
* "File-system" is used consistently in this man page, but is
inconsistent with virtually every other man page (excepting the
context of kernel options), which typically use "file system", so I
adjusted it.
* There's a hypen in the wrong place in "file-meta data".

>How-To-Repeat:

>Fix:
--- fileassoc.9~
+++ fileassoc.9	2016-11-07 21:17:34.750187349 -0500
@@ -25,12 +25,12 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd January 26, 2010
+.Dd November 7, 2016
 .Dt FILEASSOC 9
 .Os
 .Sh NAME
 .Nm fileassoc
-.Nd in-kernel, file-system independent, file-meta data association
+.Nd in-kernel, file system independent, file meta-data association
 .Sh SYNOPSIS
 .In sys/fileassoc.h
 .Ft int
@@ -56,12 +56,12 @@
 .Sh DESCRIPTION
 The
 .Nm
-KPI allows association of meta-data with files independent of file-system
+KPI allows association of meta-data with files independent of file system
 support for such elaborate meta-data.
 .Pp
 When plugging a new fileassoc to the system, a developer can specify private
 data to be associated with every file, as well as (potentially different)
-private data to be associated with every file-system mount.
+private data to be associated with every file system mount.
 .Pp
 For example, a developer might choose to associate a custom ACL with every
 file, and a count of total files with ACLs with the mount.
@@ -88,7 +88,7 @@
 management only for
 .Nm
 internal memory.
-Any additional memory stored in the tables (such as private data-structures
+Any additional memory stored in the tables (such as private data structures
 used by custom fileassocs) should be allocated and freed by the developer.
 .Pp
 .Nm
@@ -172,7 +172,7 @@
 .Pp
 If specified, the fileassoc's
 .Dq cleanup routine
-will be called with a pointer to the private data-structure.
+will be called with a pointer to the private data structure.
 .Pp
 .It Fn fileassoc_table_run "mp" "id" "cb" "cookie"
 For each entry for
@@ -225,7 +225,7 @@
 .Pp
 If specified, the fileassoc's
 .Dq cleanup routine
-will be called with a pointer to the private data-structure and indication of
+will be called with a pointer to the private data structure and indication of
 .Dv FILEASSOC_CLEANUP_FILE .
 .El
 .Sh EXAMPLES
@@ -334,6 +334,8 @@
 .Nm
 is implemented within
 .Pa src/sys/kern/kern_fileassoc.c .
+.Sh SEE ALSO
+.Xr veriexec 9
 .Sh HISTORY
 The
 .Nm



Home | Main Index | Thread Index | Old Index