Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 17 Jul 2002 18:28:27 +0200
From:      Sheldon Hearn <sheldonh@starjuice.net>
To:        Dima Dorfman <dima@trit.org>
Cc:        current@freebsd.org
Subject:   Re: DEVFS rule subsystem (was: cvs commit: src/sbin Makefile src/sbin/devfs Makefile devfs.8 devfs.c extern.h rule.c src/sys/conf files src/sys/fs/devfs devfs.h devfs_devs.c devfs_rule.c devfs_vfsops.c devfs_vnops.c )
Message-ID:  <20020717162827.GA751@starjuice.net>
In-Reply-To: <20020717015221.30D953E22@turbine.trit.org>
References:  <200207170146.g6H1kpWl024662@freefall.freebsd.org> <20020717015221.30D953E22@turbine.trit.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On (2002/07/17 01:52), Dima Dorfman wrote:

> The devfs(8) manual page is a pretty good reference of the existing
> features and semantics, but it lacks polish needed to be able to serve
> as an introduction.

Actually, I think it's brilliant.

The only nits are the weird sections, which made it hard for me to find
my way around.  For example, the examples are all in an Examples
subsection of the non-standard RULE SUBSYSTEM section, so I didn't see
that there were examples when I first looked for them.

I'd suggest the attached patch, to make it easier for manpage die-hards
to navigate.

Great job, man!

Ciao,
Sheldon.

Index: devfs.8
===================================================================
RCS file: /home/ncvs/src/sbin/devfs/devfs.8,v
retrieving revision 1.1
diff -u -d -r1.1 devfs.8
--- devfs.8	17 Jul 2002 01:46:47 -0000	1.1
+++ devfs.8	17 Jul 2002 16:25:02 -0000
@@ -62,7 +62,7 @@
 operates on
 .Pa /dev .
 .El
-.Sh RULE SUBSYSTEM
+.Ss Rule Subsystem
 The
 .Xr devfs 5
 rule subsystem provides a way for the administrator of a system to control
@@ -207,9 +207,7 @@
 .It Cm unhide
 Unhide the node.
 .El
-.Ss Notes
-.Bl -bullet -offset indent
-.It
+.Sh IMPLEMENTATION NOTES
 Rulesets are created by the kernel at the first reference,
 and destroyed when the last reference disappears.
 E.g., a ruleset is created when a rule is added to it or when it is set
@@ -218,12 +216,12 @@
 and no other references to it exist
 (i.e., it is not included by any rules, and it is not the current ruleset
 for any mount-point).
-.It
+.Pp
 Ruleset number 0 is the default ruleset for all new mount-points.
 It is always empty, cannot be modified or deleted, and does not show up
 in the output of
 .Cm showsets .
-.It
+.Pp
 Rules and rulesets are unique to the entire system,
 not a particular mount-point.
 I.e., a
@@ -232,8 +230,7 @@
 .Fl m .
 The mount-point is only relevant when changing what its current ruleset is,
 or when using one of the apply commands.
-.El
-.Ss Examples
+.Sh EXAMPLES
 When the system boots,
 the only ruleset that exists is ruleset number 0;
 since the latter may not be modified, we have to create another ruleset

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-current" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020717162827.GA751>