Date: Sun, 28 May 2006 13:12:12 -0600 (MDT) From: "M. Warner Losh" <imp@bsdimp.com> To: netchild@freebsd.org Cc: cvs-src@freebsd.org, phk@phk.freebsd.dk, src-committers@freebsd.org, rwatson@freebsd.org, cvs-all@freebsd.org Subject: Re: cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound Doxyfile-dev_usb Doxyfile-geom Doxyfile-i4b Doxyfile-kern Doxyfile-libkern Doxyfile-linux Doxyfile-net80211 ... Message-ID: <20060528.131212.-1037137048.imp@bsdimp.com> In-Reply-To: <20060528123915.7fe8e278@Magellan.Leidinger.net> References: <20060527104539.1f4c0738@Magellan.Leidinger.net> <20060527200440.G79162@fledge.watson.org> <20060528123915.7fe8e278@Magellan.Leidinger.net>
next in thread | previous in thread | raw e-mail | index | archive | help
In message: <20060528123915.7fe8e278@Magellan.Leidinger.net> Alexander Leidinger <netchild@freebsd.org> writes: : But when we have marked the internal functions as such, we can also : generate an official version without the internal functions. It's just : a switch. But so far I think we need to include everything until a : subsystem is fully documented. I think we should document everything and mark the *EXTERNAL* functions as such. I agree with your commentary about having full kernel docs, and approved API subset as well. However, kernel functions are by default internal unless we deside otherwise. : Since we have no API docs, everyone has to have a look at the kernel on : his own. This only provides a little bit of help here. We have api docs. Please don't say that we have none. There's a bunch of documentation in the man9 section of the man page. Sure, it is incomplete, misleading and obsolete in places, but it is documentation. : Since we are Open Source they can have a look and use unofficial parts : without our docs. But when we clearly say "this is for internal use : only", they can't moan. And we as developers have a benefit from the : docs too. I agree with this. I guess my only point of disagreement are the default sense of internal/external. Warner
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20060528.131212.-1037137048.imp>