Date: Tue, 05 Jan 1999 09:01:04 -0800 From: "Jordan K. Hubbard" <jkh@zippy.cdrom.com> To: conrads@neosoft.com Cc: doc@FreeBSD.ORG Subject: Re: Kernel configuration docs a neglected area? Message-ID: <5637.915555664@zippy.cdrom.com> In-Reply-To: Your message of "Tue, 05 Jan 1999 08:04:14 CST." <XFMail.990105080414.conrads@neosoft.com>
next in thread | previous in thread | raw e-mail | index | archive | help
> But you see, that's the problem. I'd gladly help out with this (writing > that AWE setup tutorial has whet my appetite for doc-writing), but there > are still too many things in LINT that aren't totally clear to me (I'm sure > I'm not alone in this), and where to find the needed information is fairly > mysterious in some cases. No mystery at all - UTSL! :-) Seriously, the sources are really the only docs for most of this stuff and *somebody* ends up needing to mine them for information at some stage in the doc process, so it's not like that's an optional part of the gig anyway. The authors of each chunk of code (most of whom are unavailable to us) are usually the least help in this, to be honest, since all their free time is taken up just in worrying about the purely technical issues. Also, the best programmers seems to be the worst at writing docs. :-) > Perhaps if each person responsible for item X in LINT could simply provide > a pointer to any existing documentation for their particular contribution, > a simple "see man X" or "see /usr/share/doc/foo/X" in LINT, might at least > get us off to a decent start. If you wait for this to happen, hell will freeze over before the doc gets written. :) > Incidentally, if you've checked out my AWE tutorial and see no problems > with it, feel free to include a pointer to it in LINT, if you like: I'd prefer for us to bring all such docs into a central place and then come up with a terser comment markup standard for LINT if that's how we choose to go. Otherwise, you get various links timing out and comments in LINT which go stale and require manual intervention. - Jordan 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?5637.915555664>