Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 14 Dec 1999 05:58:36 -0600
From:      Mike Pritchard <mpp@mppsystems.com>
To:        "Ronald F. Guilmette" <rfg@monkeys.com>
Cc:        Alexey Zelkin <phantom@cris.net>, freebsd-doc@FreeBSD.ORG
Subject:   Re: docs/14563: Wrong manpage produced by `man 4 fd'
Message-ID:  <19991214055836.D5022@mppsystems.com>
In-Reply-To: <10954.945132451@monkeys.com>
References:  <19991213221101.A602@scorpion.crimea.ua> <10954.945132451@monkeys.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Dec 13, 1999 at 04:47:31PM -0800, Ronald F. Guilmette wrote:
> In message <19991213221101.A602@scorpion.crimea.ua>, you wrote:
> >On Mon, Dec 13, 1999 at 01:50:02AM -0800, Ronald F. Guilmette wrote:
> >
> >>  >> 	Typing "man 4 fd" produces a man page talking generally about UNIX
> >>  >> 	file descriptors.
> >>  >> 
> >>  >> 	This is in conflict with the established convention that `man 4 foo'
> >>  >> 	produces documentation for the `foo' device type (and its driver).
> >>  >> 
> >>  >> 	`man 4 fd' should produce documentation relating to the `fd' (floppy
> >>  >> 	disk) device type.  (See `man 4 fdc')
> >>  >> 
> >>  >> >How-To-Repeat:
> >>  >> 
> >>  >> 	man 4 fd
> >>  >> 
> >>  >> >Fix:
> >>  >> 
> >>  >> 	Use `man 4 fdc' instead.
> >>  >
> >>  >Sorry, I don't understand.  The situation is as you say it is.  Are you
> >>  >documenting the fact, or do you want it fixed?
> >>  
> >>  I'd like to see it fixed.
> >
> >What exactly ? Rename fdc(4) -> fd(4) ? Ok. Any suggestions on new name for
> >current fd(4) then ?
> 
> Just throw that away.  Or else take that material and put it into intro(2),
> where it ought to be.
> 
> Basic information about data thingies... e.g. unix file descriptors, UIDs,
> GIDs, timeval thingies, semaphore identifiers, SysV shared memory identifiers,
> and all info about all such basic data thingies should go into intro(2).

But /dev/fd, which is what fd(4) describe, is different from the
general description about file descriptors you would like to
see in intro(2).  

fdc(4) matches what we use in the kernel config files, and that is
appropriate.  Unless we rename how we refernce floppy disks
in the kernel, the name should stay fdc(4).

-Mike
-- 
Mike Pritchard
mpp@FreeBSD.org or mpp@mppsystems.com


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




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