From owner-freebsd-hackers  Wed Jul 31 23:07:07 1996
Return-Path: owner-hackers
Received: (from root@localhost)
          by freefall.freebsd.org (8.7.5/8.7.3) id XAA00382
          for hackers-outgoing; Wed, 31 Jul 1996 23:07:07 -0700 (PDT)
Received: from parkplace.cet.co.jp (parkplace.cet.co.jp [202.32.64.1])
          by freefall.freebsd.org (8.7.5/8.7.3) with ESMTP id XAA00377
          for <hackers@freebsd.org>; Wed, 31 Jul 1996 23:07:04 -0700 (PDT)
Received: from localhost (michaelh@localhost) by parkplace.cet.co.jp (8.7.5/CET-v2.1) with SMTP id GAA20593; Thu, 1 Aug 1996 06:06:39 GMT
Date: Thu, 1 Aug 1996 15:06:39 +0900 (JST)
From: Michael Hancock <michaelh@cet.co.jp>
To: David Leonard <leonard@dstc.edu.au>
cc: hackers@freebsd.org
Subject: Re: kernel assertions (Rev. 1)
In-Reply-To: <199608010347.NAA13864@foxtail.dstc.edu.au>
Message-ID: <Pine.SV4.3.93.960801150139.20486A-100000@parkplace.cet.co.jp>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: owner-hackers@freebsd.org
X-Loop: FreeBSD.org
Precedence: bulk

On Thu, 1 Aug 1996, David Leonard wrote:

> Looking at it again, I think it would raise the readability (and hence
> learnability/searchability(?)) of the FreeBSD source tree no end! In some ways,

You can write a utility that searches all the files in the source tree and
prints out a specification for you like the following ...

void
bremfree(struct buf * bp)

   REQUIRE("that bp points to something", bp != NULL);

   ENSURE( "that the buffer is no longer queued",
		bp->b_qindex == QUEUE_NONE );

...


How's that for documentation?

Regards,


Mike Hancock