From owner-cvs-src@FreeBSD.ORG Sun May 28 21:10:36 2006 Return-Path: X-Original-To: cvs-src@FreeBSD.ORG Delivered-To: cvs-src@FreeBSD.ORG Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 940A816C78D; Sun, 28 May 2006 20:59:45 +0000 (UTC) (envelope-from rwatson@FreeBSD.org) Received: from cyrus.watson.org (cyrus.watson.org [209.31.154.42]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1E04F43D53; Sun, 28 May 2006 20:59:45 +0000 (GMT) (envelope-from rwatson@FreeBSD.org) Received: from fledge.watson.org (fledge.watson.org [209.31.154.41]) by cyrus.watson.org (Postfix) with ESMTP id A82E246BF1; Sun, 28 May 2006 16:59:44 -0400 (EDT) Date: Sun, 28 May 2006 21:59:44 +0100 (BST) From: Robert Watson X-X-Sender: robert@fledge.watson.org To: "M. Warner Losh" In-Reply-To: <20060528.140140.652863809.imp@bsdimp.com> Message-ID: <20060528215904.B79162@fledge.watson.org> References: <20060528123915.7fe8e278@Magellan.Leidinger.net> <20060528.131212.-1037137048.imp@bsdimp.com> <20060528214157.71671d52@Magellan.Leidinger.net> <20060528.140140.652863809.imp@bsdimp.com> MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed Cc: cvs-src@FreeBSD.ORG, phk@phk.freebsd.dk, src-committers@FreeBSD.ORG, netchild@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 ... X-BeenThere: cvs-src@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: CVS commit messages for the src tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 28 May 2006 21:10:38 -0000 On Sun, 28 May 2006, M. Warner Losh wrote: > : > : 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). > > Again, between the handbook and the man pages we have this. It needs a lot > of work, but we do have it. It shows what to do at a very rudamentary > level, but you can find what you want. > > I'm not sure you'll ever find the high level overview in the sources. > There's rarely a good place for it, and it changes with time. Historically, the BSD Book, and now the FreeBSD Book have served this role. Robert N M Watson