From owner-freebsd-arch@FreeBSD.ORG  Tue May 20 21:57:12 2003
Return-Path: <owner-freebsd-arch@FreeBSD.ORG>
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 DDC4037B401; Tue, 20 May 2003 21:57:12 -0700 (PDT)
Received: from mail.chesapeake.net (chesapeake.net [208.142.252.6])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id B52DC43F93; Tue, 20 May 2003 21:57:11 -0700 (PDT)
	(envelope-from jroberson@chesapeake.net)
Received: from localhost (jroberson@localhost)
	by mail.chesapeake.net (8.11.6/8.11.6) with ESMTP id h4L4vAc56197;
	Wed, 21 May 2003 00:57:10 -0400 (EDT)
	(envelope-from jroberson@chesapeake.net)
Date: Wed, 21 May 2003 00:57:10 -0400 (EDT)
From: Jeff Roberson <jroberson@chesapeake.net>
To: Hiten Pandya <hmp@FreeBSD.ORG>
In-Reply-To: <20030520203418.GA92706@perrin.int.nxad.com>
Message-ID: <20030521004947.X52717-100000@mail.chesapeake.net>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
cc: arch@FreeBSD.ORG
cc: jeff@FreeBSD.ORG
cc: des@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
	<freebsd-arch.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-arch>,
	<mailto:freebsd-arch-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-arch>
List-Post: <mailto:freebsd-arch@freebsd.org>
List-Help: <mailto:freebsd-arch-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-arch>,
	<mailto:freebsd-arch-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 21 May 2003 04:57:13 -0000

On Tue, 20 May 2003, 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.
>

Sorry Hiten, I'm pretty well occupied lately.  I was just telling mini
that I need to get back to you on this.

Anyway, I have a few comments.  The ae_flags are for internal use only.
Consumers of the API should not modify them.

The second sentence in the section describing alq_open() is a little bit
confusing.  Please considering breaking it up.

You should probably say 'with the "alqget" wait message'.  The wait
channel is not so important to the consumer of the API.

You might want to go into a little detail about how alq_get() and
alq_post() are intended as a more effecient way to do alq_write().  They
save the memcpy into the ale.

Thanks!
Jeff

> Viewing copy is available:
>
> 	http://people.FreeBSD.ORG/~hmp/manpages/alq.9.pdf
> 	http://people.FreeBSD.ORG/~hmp/manpages/alq.9.txt
>
> Groff copy of the manual page:
>
> 	http://people.FreeBSD.ORG/~hmp/manpages/alq.9
>
> The manual page has been reviewed by my mentor (des@).
> Commands and suggestions welcome.
>
> Thanking in anticipation.
>
> 	-- Hiten (hmp@FreeBSD.ORG)
>