NetBSD Problem Report #51611

From www@NetBSD.org  Tue Nov  8 02:31:45 2016
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(Client CN "mail.netbsd.org", Issuer "Postmaster NetBSD.org" (verified OK))
	by mollari.NetBSD.org (Postfix) with ESMTPS id 646087A26E
	for <gnats-bugs@gnats.NetBSD.org>; Tue,  8 Nov 2016 02:31:45 +0000 (UTC)
Message-Id: <20161108023144.090447A2C8@mollari.NetBSD.org>
Date: Tue,  8 Nov 2016 02:31:44 +0000 (UTC)
From: dhgutteridge@sympatico.ca
Reply-To: dhgutteridge@sympatico.ca
To: gnats-bugs@NetBSD.org
Subject: Minor adjustments to the fileassoc(9) man page
X-Send-Pr-Version: www-1.0

>Number:         51611
>Category:       misc
>Synopsis:       Minor adjustments to the fileassoc(9) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pgoyette
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Nov 08 02:35:00 +0000 2016
>Closed-Date:    Tue Nov 08 02:43:56 +0000 2016
>Last-Modified:  Sun Dec 18 06:45:01 +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

>Release-Note:

>Audit-Trail:

Responsible-Changed-From-To: misc-bug-people->pgoyette
Responsible-Changed-By: pgoyette@NetBSD.org
Responsible-Changed-When: Tue, 08 Nov 2016 02:40:55 +0000
Responsible-Changed-Why:
I'll merge these changes.


State-Changed-From-To: open->closed
State-Changed-By: pgoyette@NetBSD.org
State-Changed-When: Tue, 08 Nov 2016 02:43:56 +0000
State-Changed-Why:
changes have been merged and committed


From: "Paul Goyette" <pgoyette@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/51611 CVS commit: src/share/man/man9
Date: Tue, 8 Nov 2016 02:43:30 +0000

 Module Name:	src
 Committed By:	pgoyette
 Date:		Tue Nov  8 02:43:29 UTC 2016

 Modified Files:
 	src/share/man/man9: fileassoc.9

 Log Message:
 Merge changes from David H. Gutteridge in PR misc/51611

 Thanks!


 To generate a diff of this commit:
 cvs rdiff -u -r1.27 -r1.28 src/share/man/man9/fileassoc.9

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

From: "Soren Jacobsen" <snj@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/51611 CVS commit: [netbsd-7] src/share/man/man9
Date: Sun, 18 Dec 2016 06:43:24 +0000

 Module Name:	src
 Committed By:	snj
 Date:		Sun Dec 18 06:43:24 UTC 2016

 Modified Files:
 	src/share/man/man9 [netbsd-7]: fileassoc.9

 Log Message:
 Pull up following revision(s) (requested by riastradh in ticket #1314):
 	share/man/man9/fileassoc.9: revision 1.28
 Merge changes from David H. Gutteridge in PR misc/51611
 Thanks!


 To generate a diff of this commit:
 cvs rdiff -u -r1.27 -r1.27.4.1 src/share/man/man9/fileassoc.9

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

>Unformatted:

Home	PR Database Search