ALQ manual page review

[Mike Makonnen]

On Tue, 20 May 2003 13:34:18 -0700
Hiten Pandya <hmp at FreeBSD.org> 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 at identd.net | D228 1A6F C64E 120A A1C9  A3AA DAE1 E2AF DBCC 68B9
mtm at FreeBSD.Org| FreeBSD - The Power To Serve