Date: Thu, 6 Jul 2000 15:47:08 -0600 From: "Kenneth D. Merry" <ken@kdm.org> To: Sheldon Hearn <sheldonh@uunet.co.za> Cc: arch@FreeBSD.ORG Subject: Re: Why don't section 4 pages live with their drivers? Message-ID: <20000706154708.B25951@panzer.kdm.org> In-Reply-To: <15951.962878183@axl.ops.uunet.co.za>; from sheldonh@uunet.co.za on Thu, Jul 06, 2000 at 12:09:43PM %2B0200 References: <15951.962878183@axl.ops.uunet.co.za>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Jul 06, 2000 at 12:09:43 +0200, Sheldon Hearn wrote: > > Hi folks, > > I notice that a lot of section 4 manual pages live in src/share/man/man4 > instead of in the subdirectory in which the code that implements the > associated drivers resides. > > I realize that many drivers have bits in too many directories for this > to be possible. > > Case in point: I'm about to commit the md.4 manual page of phk's. I > would have thought that the right place for it would be src/sys/dev/md, > but the precedents which I can see certainly indicates that this would > be "wrong". > > Bottom line: where do I put this thing and if it's not in > src/sys/dev/md, why not? The main reason I can see not to do it is consistency. As you pointed out, with many drivers, the parts are all over the place. So there isn't one "right" place to put the man page. Another problem is when you're doing stuff like: cd /usr/src/sys find . -type f -print |xargs grep foofunc Of course you could just do 'find . -name "*.[ch]" -print...', but the first version of the command would give you mdoc output as well as C. Another issue is that this would clutter up shared directories like sys/pci -- you'd have a ton of man pages for various drivers as well as all the source code. With userland commands and libraries, things are separated out into different directories and it makes sense to put the man pages in the same place. With kernel man pages (section 4 and section 9), I think it makes things a little easier to just keep them in one place. I'm not hard-set against this change, but I do think the things I outlined above should be taken into consideration. Ken -- Kenneth Merry ken@kdm.org To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-arch" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000706154708.B25951>