Quoting "M. Warner Losh" <[EMAIL PROTECTED]> (Sun, 28 May 2006 13:12:12 -0600 (MDT)):
> In message: <[EMAIL PROTECTED]> > Alexander Leidinger <[EMAIL PROTECTED]> 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. We can make this a 3-tier document. We can mark some functions as @internal, some without any special markup (they are public then), and some with some special comments/notes/whatever (we have to invent something). The functions marked as @internal are only for the use in the subsystem itself (maybe together with any other documented constraint). The functions without any special markup can be used in other subsystems of the kernel. And finally the special marked functions -- let's call them EXTERNAL -- can be used by 3rd party developers. How does this sound? > : 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. Sorry... there are docs which document the API, I agree. But we don't really have well known API documentation (as in high level overview, what fits together how, and such). You have to know what you want to do, then you can make use of plenty of docs. But if you don't know what you are searching, it's not easy (maybe more easy as in linux, I don't know, but not as easy as it could be). Bye, Alexander. -- Selling GoodYear Eagle F1 235/40ZR18, 2x 4mm + 2x 5mm, ~150 EUR you have to pick it up between Germany/Saarland and Luxembourg/Capellen http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID = B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID = 72077137 _______________________________________________ cvs-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/cvs-all To unsubscribe, send any mail to "[EMAIL PROTECTED]"
