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

[John Baldwin]

On Wednesday 27 September 2006 04:22, danger at rulez.sk wrote:
> Quoting Christian Brueffer <brueffer at FreeBSD.org>:
> 
> > On Tue, Sep 26, 2006 at 07:59:52PM +0000, Daniel Gerzo wrote:
> >> danger      2006-09-26 19:59:52 UTC
> >>
> >>   FreeBSD src repository (doc committer)
> >>
> >>   Modified files:
> >>     share/examples/mdoc  example.4
> >>   Log:
> >>   Remove second person from the sentece and rephrase a bit.
> >>
> >>   Approved by: trhodes (mentor), keramida (mentor)
> >>
> >>   Revision  Changes    Path
> >>   1.26      +6 -8      src/share/examples/mdoc/example.4
> >
> > I don't agree to these changes, see below for details (also I don't see 
where
> > exactly you removed second person usage, it's still being used in the new
> > version).
> 
> We want to aviod to use words like "you", "your" and so on. I have  
> talked about it with Ruslan and my mentors.
> 
> >> | -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".
> 
> I think it's certainly clear to users that they can either enable  
> support for something in kernel _or_ load it as a module which would  
> bring that support without need of kernel recompilation.

Not in the text you just wrote.  The diff quoted above would now imply to at 
least some users that you have to compile drivers into the kernel since 
that's how one "enable[s] support for foo(4)".

-- 
John Baldwin