cvs commit: src/share/examples/mdoc example.4

[Christian Brueffer]

On Wed, Sep 27, 2006 at 04:15:26AM -0400, Tom Rhodes wrote:
> On Wed, 27 Sep 2006 08:53:14 +0100
> Ceri Davies <ceri at submonkey.net> wrote:
> 
> > On Wed, Sep 27, 2006 at 03:41:24AM -0400, Tom Rhodes wrote:
> > > On Tue, 26 Sep 2006 22:23:39 +0200
> > > Christian Brueffer <brueffer at FreeBSD.org> wrote:
> > 
> > > > > | @@ -33,11 +33,9 @@
> > > > > |  .Nm example
> > > > > |  .Nd "example device driver manual page"
> > > > > |  .Sh SYNOPSIS
> > > > > | -To compile the
> > > > > | -.Ns Nm
> > > > > | -driver into the kernel,
> > > > > | -place the following lines in the
> > > > > | -kernel configuration file:
> > > > > | +To enable support for
> > > > > | +.Ns Nm ,
> > > > > | +place the following lines in the kernel configuration file:
> > > > 
> > > > The formulation used before was much more accurate WRT the distinction
> > > > we make between compiling something into the kernel and loading it as a
> > > > module.  If we load something as a module we also "enable support for
> > > > it".
> > > 
> > > What about in cases where other hoops must be jumped before the
> > > driver/feature/whatever is really supported?
> > 
> > They can be special cased in the real manual.  In the wider sense,
> > kldload is the easiest way to enable support for something, and I know
> > that I'm personally well past encouraging users to recompile the kernel
> > just to get, for example, sound working when a simple kldload does the
> > job just as well in most cases.
> 
> That is of course that "something" has a module.  ;)
> 
> Seriously though, why handle one case any differently than
> another?  We should be fair here, and the above version will
> work for anything ... although, to be exact, we should probably
> use:
> 

I don't understand your reasoning for using "to enable support".  Using
this would actually be wrong if there's more to do than recompiling the
kernel, as that alone would not really enable support for $SOMETHING.

OTOH if you have to e.g. set a sysctl value to enable this support, this
would likely have to be done for the module case as well, so the old
formulation would be better.

Care to elaborate?

> "place the following line(s) in the kernel configuration file:"
> 
> 
> > 
> > > > > |  .Bd -ragged -offset indent
> > > > > |  .Cd "device example"
> > > > > |  .Cd "options EXAMPLE_DEBUG"
> > > > > | @@ -45,9 +43,9 @@ kernel configuration file:
> > > > > |  .Pp
> > > > > |  Alternatively, to load the
> > > > > |  .Ns Nm
> > > > > | -driver as a
> > > > > | -module at boot time, place the following line in
> > > > > | -.Xr loader.conf 5 :
> > > > > | +as a module at boot time, add the following line into the
> > > > > | +.Xr loader.conf 5
> > > > > | +file:
> > > > > |  .Bd -literal -offset indent
> > > > > |  example_load="YES"
> > > > > |  .Ed
> > > > > 
> > > > 
> > > > Removing "driver" here is wrong.  "...to load the .Nm..." what, the .Nm
> > > > driver?  The .Nm utility?  It's just incorrect to rely on context here
> > > > and it makes the sentence sound really awkward.
> > > 
> > > Leaving driver here is wrong.
> > 
> > Not if you also leave the word "the" before .Nm.
> 
> Then we should bloat it to handle "the XXX driver," "the XXX
> subsystem," "the XXX system," etc.  To be honest, the sentence
> sounds better to me this way.  And putting "driver" back in
> just does what Christian says it's there to prevent.  We should
> not really "rely on the context" here, so I agree with Christian.
> We shouldn't believe that it will always be a "driver."
> 

You're twisting my argument here ;-)  Of course this is an example,
so I can't be said whether it's a driver or a subsystem.  But anyone
who is using this template _probably_ knows what he's modifying the
example for and will just replace that word with whatever is correct.
However leaving the word out will just result in an incorrect sentence
(we still have several of those in our manpages, e.g. "utility" and
"command" are among the favourite words that are left out).

So in this case, put in driver/subsystem/whatever, but put in
_something_.

> In any sense, it's still just an "example."  We are arguing over
> an "example" people.
> 

I know :-)  But having good examples means less editing to do when a
new page based on this example hits the tree.  That's exactly the reason
for my last couple of commits to this manpage.

- Christian

-- 
Christian Brueffer	chris at unixpages.org	brueffer at FreeBSD.org
GPG Key:	 http://people.freebsd.org/~brueffer/brueffer.key.asc
GPG Fingerprint: A5C8 2099 19FF AACA F41B  B29B 6C76 178C A0ED 982D
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/cvs-src/attachments/20060927/8242ab75/attachment.pgp