From owner-freebsd-stable Tue Apr 17 12:33:54 2001 Delivered-To: freebsd-stable@freebsd.org Received: from raven.ravenbrook.com (raven.ravenbrook.com [193.82.131.18]) by hub.freebsd.org (Postfix) with ESMTP id C4B9237B43E for ; Tue, 17 Apr 2001 12:33:44 -0700 (PDT) (envelope-from nb@ravenbrook.com) Received: from thrush.ravenbrook.com (thrush.ravenbrook.com [193.112.141.249]) by raven.ravenbrook.com (8.9.3/8.9.3) with ESMTP id UAA16339; Tue, 17 Apr 2001 20:33:40 +0100 (BST) Received: from thrush.ravenbrook.com (localhost [127.0.0.1]) by thrush.ravenbrook.com (8.11.2/8.11.2) with ESMTP id f3HJYEK01159; Tue, 17 Apr 2001 19:34:14 GMT (envelope-from nb@thrush.ravenbrook.com) From: Nick Barnes To: "Daryl Chance" Cc: stable@FreeBSD.ORG Subject: Re: Programmers Documentation Project In-Reply-To: Message from "Daryl Chance" of "Tue, 17 Apr 2001 13:36:40 EST." <001501c0c76d$58726ab0$0200000a@satan> Date: Tue, 17 Apr 2001 19:34:14 +0000 Message-ID: <1157.987536054@thrush.ravenbrook.com> Sender: owner-freebsd-stable@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG I think a start for browsing is running LXR on the code. has a slightly older set of the sources (4.0?), but is a great help. If the FreeBSD project were to provide this (or integrate it with the cvsweb interface) that would be great. Nick B At 2001-04-17 18:36:40+0000, "Daryl Chance" writes: > I just posted this on -doc, but I thought I'd ask you all for > thoughts on this since -stable will probably be the main target > for questions while/if this project is going on. > > --------------------------------------------------------------- > Hi, > > I was looking through the list of projects to see if one existed > for documenting the FBSD code. The closest I came to it was this: > http://home.wxs.nl/~asmodai/pdp.html > > Does anyone know if there has been any recent work done on this? > the top of this page: > http://home.wxs.nl/~asmodai/source-overview.txt > > Has a date of 1999/04/01, a little over 2 years. > > I say this is the closest, because I was looking for something else, > something a little more "thourough", like (I realize this would be > a HUGE undertaking) commenting all the functions in the FBSD source > and running something like ScanDoc against it or some other auto- > matic code documentation programs. > > Anyone have any suggestions? Offer any help? I thought about this > which watching the recent discussion on "VM Balance" on -stable. > This would be a great project to start so that someone interested > in browsing the FBSD source can see more then just the code, they > can see the functions, structs, etc etc and read the comments > against those. It may help the people doing work on FBSD to learn > more about the source. > > Thoughts? I'd be willing to help out, or even lead this project. > I do think this would take a lot of patience from the -stable people > answering our questions about things that they would consider > trivial :). I'm only on a Cable connection w/ a K6 333 as my most > powerful server, but I can offer up this to see this project get off > the ground and to show that theres some interest. I'd also have > to learn scandoc or whatever documentation tool we plan on using if > theres any interest. > > Thanks, > Daryl Chance > > > To Unsubscribe: send mail to majordomo@FreeBSD.org > with "unsubscribe freebsd-stable" in the body of the message > To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-stable" in the body of the message