docs/39214: No my(4) man page

[Tom Rhodes]

On Fri, 16 May 2003 13:18:05 -0700
Hiten Pandya <hmp at freebsd.org> wrote:

> On Fri, May 16, 2003 at 03:56:37PM -0400, Tom Rhodes wrote:
> > Oh, we're doing *real* nitpicks?  Well then, I might as well chime in
> > here then!  Below I've listed several comments.
> > 
> > 
> > The
> > .Nm
> > driver will probe for a Myson chip, check the PCI vendor and device IDs
> > against our list of supported devices, and return a device name if we find a match.
> > If a device is located
> >
> > [ ... snip ...]
> 
> 	Tom, this stuff is implementation details which are unwated.
> 	Well, maybe I could put it in my(4) IMPLEMENTATION NOTES, but I
> 	highly doubt it will be of use to anyone since these steps are
> 	taken by just about any network driver, and should go to a more
> 	generic place.

That would be fine.  Personally, I think manual pages should be as
descriptive as possible without being redundant.  The IMPLEMENTATION NOTES
would be fine.

If you do a cut'n paste, please do an s/BPF/bpf which I noticed
after I sent the email.

> 
> > - Another thing you could do, to expand on the page a
> > little bit is add a .Sh FILES section and list the two files:
> > 
> > .Pa /usr/src/sys/dev/my/if_my.c
> > and
> > .Pa /usr/src/sys/dev/my/if_myreg.h
> > 
> > and add a small description of them.
> 
> 	Ok, a FILES section sounds a like a good idea. 8-)
> 
> > - ifmedia (used in the above list) could use a manual page, I've got a
> > WIP for this.  Actually, I have many WIPs, but I need time to get them
> > reviewed before the patches are applied.
> 
> 	Send 'em over to me.  Some people can't thank me enough for my
> 	delegation skills. 8-)

Oh you don't want them!  Trust me.  :)

> 
> > - This email was not ment to be so long...
> 

Take care Hiten, thanks for all your work!

--
Tom Rhodes