ALQ manual page review

[Brooks Davis]

On Wed, May 21, 2003 at 12:52:51PM -0400, Mike Makonnen wrote:
> 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.

I second this.  I find the RETURN VALUES sections especialy useful.

Thanks for the good work Hiten!

-- Brooks

-- 
Any statement of the form "X is the one, true Y" is FALSE.
PGP fingerprint 655D 519C 26A7 82E7 2529  9BF0 5D8E 8BE9 F238 1AD4
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/freebsd-arch/attachments/20030521/77565e7c/attachment.bin