From owner-freebsd-chat@FreeBSD.ORG  Tue Apr 22 12:15:49 2003
Return-Path: <owner-freebsd-chat@FreeBSD.ORG>
Delivered-To: freebsd-chat@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 848F537B401
	for <freebsd-chat@freebsd.org>; Tue, 22 Apr 2003 12:15:49 -0700 (PDT)
Received: from bluejay.mail.pas.earthlink.net (bluejay.mail.pas.earthlink.net
	[207.217.120.218])
	by mx1.FreeBSD.org (Postfix) with ESMTP id B4B5E43FAF
	for <freebsd-chat@freebsd.org>; Tue, 22 Apr 2003 12:15:48 -0700 (PDT)
	(envelope-from tlambert2@mindspring.com)
Received: from pool0258.cvx40-bradley.dialup.earthlink.net ([216.244.43.3]
	helo=mindspring.com)
	by bluejay.mail.pas.earthlink.net with asmtp (SSLv3:RC4-MD5:128)
	(Exim 3.33 #1)	id 1983F1-0006m6-00; Tue, 22 Apr 2003 12:15:44 -0700
Message-ID: <3EA5948D.EDB810B2@mindspring.com>
Date: Tue, 22 Apr 2003 12:14:21 -0700
From: Terry Lambert <tlambert2@mindspring.com>
X-Mailer: Mozilla 4.79 [en] (Win98; U)
X-Accept-Language: en
MIME-Version: 1.0
To: Colin Percival <colin.percival@wadham.ox.ac.uk>
References: <5.0.2.1.1.20030422171035.01c5e258@popserver.sfu.ca>
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
X-ELNK-Trace: b1a02af9316fbb217a47c185c03b154d40683398e744b8a4e8a0c788e9771a97856588f62fa12e8993caf27dac41a8fd350badd9bab72f9c350badd9bab72f9c
cc: Jonathon McKitrick <jcm@FreeBSD-uk.eu.org>
cc: freebsd-chat@freebsd.org
Subject: Re: Code layout and debugging time
X-BeenThere: freebsd-chat@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Non technical items related to the community
	<freebsd-chat.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-chat>,
	<mailto:freebsd-chat-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-chat>
List-Post: <mailto:freebsd-chat@freebsd.org>
List-Help: <mailto:freebsd-chat-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-chat>,
	<mailto:freebsd-chat-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 22 Apr 2003 19:15:49 -0000

Colin Percival wrote:
> It would be interesting to see if a similar effect can be observed
> in heavily commented code; I have a feeling that one might find that
> writing comments into a distinct "documentation" file would have an
> advantage over the usual practice of writing comments in the middle of code.

I think that there would not be a similar effect, unless the
comments were sprinkled throughout the code like pixie dust.
8-).  If they were in discrete blocks, that would be something
else (see, for example, the UFS header files, or vfs_subr.c,
where it talks about soft updates and the syncer).

If you ever find and Open Source that qualifies as "heavily
commented", let us know, and we can go take a look.

8-) 8-) 8-).

-- Terry