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

Scott Long scottl at samsco.org
Wed Sep 27 03:13:17 PDT 2006


Tom Rhodes wrote:
> On Wed, 27 Sep 2006 03:02:22 -0600
> Scott Long <scottl at samsco.org> wrote:
> 
> 
>>Daniel Gerzo wrote:
>>
>>
>>>Quoting Ceri Davies <ceri at submonkey.net>:
>>>
>>>
>>>>No, we're arguing over grammar.  The sentence currently renders as
>>>>something like:
>>>>
>>>>    Alternatively, to load the fxp(4) as a module at boot time...
>>>>
>>>
>>>I proposed the following change:
>>>
>>>Alternatively, to load
>>>.Ns Nm
>>>module at boot time...
>>>
>>>
>>>>That's wrong.  Getting rid of "the" works.
>>>>
>>>
>>It should read:
>>
>>Alternatively, to load the fxp(4) driver as a module at boot time...
>>
>>not
>>
>>Alternatively, to load fxp(4) module at boot time...
>>
>>nor
>>
>>Alternatively, to load the fxp(4) as a module at boot time...
>>
>>nor
>>
>>Alternatively, to load the fxp(4) as a module at boot time...
>>
>>The following is correct, but is inconsistent with the preceding
>>context.  There has been no introduction in text of the term
>>'module', so trying to interchange it with the term 'driver', which
>>has been introduced, is clumsy.  Furthermore, the terms 'driver' and
>>'module' are not synonymous in the context, and thus are not
>>interchangable.
>>
>>Alternatively, to load the fxp(4) module at boot time...
> 
> 
> I'd like to see "driver" and "module" removed from this particular
> example page.  :)
> 

Considering that this is meant for section 4 of the manual, and
intro.4 says the following:

   INTRO(4)         FreeBSD Kernel Interfaces Manual      INTRO(4)

   NAME
        intro -- introduction to devices and device drivers

The terms 'driver' and 'module' are very much appropriate when talking
about 'device drivers'.

Scott


More information about the cvs-src mailing list