From owner-freebsd-current@FreeBSD.ORG  Fri Aug 29 15:46:57 2008
Return-Path: <owner-freebsd-current@FreeBSD.ORG>
Delivered-To: current@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 9FDAD106566B
	for <current@freebsd.org>; Fri, 29 Aug 2008 15:46:57 +0000 (UTC)
	(envelope-from mozolevsky@gmail.com)
Received: from yx-out-2324.google.com (yx-out-2324.google.com [74.125.44.29])
	by mx1.freebsd.org (Postfix) with ESMTP id 523B58FC15
	for <current@freebsd.org>; Fri, 29 Aug 2008 15:46:57 +0000 (UTC)
	(envelope-from mozolevsky@gmail.com)
Received: by yx-out-2324.google.com with SMTP id 8so492459yxb.13
	for <current@freebsd.org>; Fri, 29 Aug 2008 08:46:56 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma;
	h=domainkey-signature:received:received:message-id:date:from:sender
	:to:subject:cc:in-reply-to:mime-version:content-type
	:content-transfer-encoding:content-disposition:references
	:x-google-sender-auth;
	bh=Os9wVEXokII4BgwqrnjYUQafWhZ7/S50ZDOLcoylc0s=;
	b=LF1HnYfFLnZuqnnnaNfqnHV/Sj9Cuv1Obi73oETtxf3aNDr09dPd1bkWqaWmXBI0WO
	lWcS1ImSVj8G9dYS9iW88XMe0wId1sA1BJ6XU+j1sXNFdxhYD9Vktv9CVObSRJFmJF2q
	Aa43hAe2xr7dds+aJxWPl/dmH4HVkAdrc53wM=
DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma;
	h=message-id:date:from:sender:to:subject:cc:in-reply-to:mime-version
	:content-type:content-transfer-encoding:content-disposition
	:references:x-google-sender-auth;
	b=YfW3/AVsbixdROAmTfd02zlcP1MGlG2jgKILB9kw4zWX2ZYJKONo1vUEOwjWm6F6hw
	JXBxOH8yh/go2JVlH+JIZ1XSD0pn/DgphybEoB6WoNyclEQwb3xae+kw0BvzIbIh/g99
	ob0eWdSOU3Odt7Pf/JuhBXTsrXHkIZGTNFF4s=
Received: by 10.151.112.3 with SMTP id p3mr4331126ybm.198.1220023531695;
	Fri, 29 Aug 2008 08:25:31 -0700 (PDT)
Received: by 10.64.201.8 with HTTP; Fri, 29 Aug 2008 08:25:31 -0700 (PDT)
Message-ID: <a2b6592c0808290825l53f7d80dv50f7eee5eb08c6e5@mail.gmail.com>
Date: Fri, 29 Aug 2008 16:25:31 +0100
From: "Igor Mozolevsky" <igor@hybrid-lab.co.uk>
Sender: mozolevsky@gmail.com
To: "Kirk Strauser" <kirk@strauser.com>
In-Reply-To: <BDDFB834-C15F-4E48-B1D1-B644940FBE42@strauser.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
References: <BDDFB834-C15F-4E48-B1D1-B644940FBE42@strauser.com>
X-Google-Sender-Auth: 6f92a2e26df6113c
Cc: current@freebsd.org
Subject: Re: System, diagnose thyself: auto-documentation for crashes
X-BeenThere: freebsd-current@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: Discussions about the use of FreeBSD-current
	<freebsd-current.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-current>, 
	<mailto:freebsd-current-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-current>
List-Post: <mailto:freebsd-current@freebsd.org>
List-Help: <mailto:freebsd-current-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-current>,
	<mailto:freebsd-current-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 29 Aug 2008 15:46:57 -0000

2008/8/29 Kirk Strauser <kirk@strauser.com>:
>
> For instance, suppose the comments in sys/vm/uma_core.c looked like:
>
> /*
>  * Frees an item to an INTERNAL zone or allocates a free bucket
>  *
>  * Arguments:
>  *      zone   The zone to free to
>  *      item   The item we're freeing
>  *      udata  User supplied data for the dtor
>  *      skip   Skip dtors and finis
>  *
>  * Failure:
>  *      Failures in this function are commonly due to defective RAM.
>  */

'Crash' would probably be a more meaningful word instead of 'failure'

;-)

--
igor