From owner-freebsd-arch@FreeBSD.ORG Wed May 21 09:52:55 2003 Return-Path: Delivered-To: freebsd-arch@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id F0FC837B404; Wed, 21 May 2003 09:52:54 -0700 (PDT) Received: from out006.verizon.net (out006pub.verizon.net [206.46.170.106]) by mx1.FreeBSD.org (Postfix) with ESMTP id 4A91A43F3F; Wed, 21 May 2003 09:52:53 -0700 (PDT) (envelope-from mtm@identd.net) Received: from kokeb.ambesa.net ([151.200.236.15]) by out006.verizon.net (InterMail vM.5.01.05.33 201-253-122-126-133-20030313) with ESMTP id <20030521165252.GJEW25800.out006.verizon.net@kokeb.ambesa.net>; Wed, 21 May 2003 11:52:52 -0500 Date: Wed, 21 May 2003 12:52:51 -0400 From: Mike Makonnen To: Hiten Pandya In-Reply-To: <20030520203418.GA92706@perrin.int.nxad.com> References: <20030520203418.GA92706@perrin.int.nxad.com> X-Mailer: Sylpheed version 0.8.10 (GTK+ 1.2.10; i386-portbld-freebsd5.0) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Authentication-Info: Submitted using SMTP AUTH at out006.verizon.net from [151.200.236.15] at Wed, 21 May 2003 11:52:51 -0500 Message-Id: <20030521165252.GJEW25800.out006.verizon.net@kokeb.ambesa.net> cc: arch@FreeBSD.org Subject: Re: ALQ manual page review X-BeenThere: freebsd-arch@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Discussion related to FreeBSD architecture List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 21 May 2003 16:52:55 -0000 On Tue, 20 May 2003 13:34:18 -0700 Hiten Pandya wrote: > Hi gang. > > I have written a manual page for the Asynchronous Logging Queues (ALQ) > facility, available in FreeBSD 5.x. I have been trying to reach Jeff by > various methods of contact (IRC, mail etc) but I have not had a response > from him. > > Viewing copy is available: > > http://people.FreeBSD.ORG/~hmp/manpages/alq.9.pdf > http://people.FreeBSD.ORG/~hmp/manpages/alq.9.txt This is really more of an "observation" than a request to do something about it. Most (all) manual pages have separate sections for 'RETURN VALUES' and 'ERRORS.' I find this very useful. While including return values and errors with the description of the function does make sense, the former makes it much easier for me to find what I'm looking for. For example, a lot of times I already know what the function does, and I just want to quickly find out what values it returns and the possible errors. Cheers. -- Mike Makonnen | GPG-KEY: http://www.identd.net/~mtm/mtm.asc mtm@identd.net | D228 1A6F C64E 120A A1C9 A3AA DAE1 E2AF DBCC 68B9 mtm@FreeBSD.Org| FreeBSD - The Power To Serve