Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 21 May 2003 10:54:11 -0700
From:      Brooks Davis <brooks@one-eyed-alien.net>
To:        Mike Makonnen <mtm@identd.net>
Cc:        arch@freebsd.org
Subject:   Re: ALQ manual page review
Message-ID:  <20030521175411.GA3076@Odin.AC.HMC.Edu>
In-Reply-To: <20030521165252.GJEW25800.out006.verizon.net@kokeb.ambesa.net>
References:  <20030520203418.GA92706@perrin.int.nxad.com> <20030521165252.GJEW25800.out006.verizon.net@kokeb.ambesa.net>

next in thread | previous in thread | raw e-mail | index | archive | help

--ZPt4rx8FFjLCG7dd
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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@FreeBSD.org> wrote:
>=20
> > Hi gang.
> >=20
> > 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.
> >=20
> > Viewing copy is available:
> >=20
> > 	http://people.FreeBSD.ORG/~hmp/manpages/alq.9.pdf
> > 	http://people.FreeBSD.ORG/~hmp/manpages/alq.9.txt
>=20
> This is really more of an "observation" than a request to do something ab=
out it.
>=20
> Most (all) manual pages have separate sections for 'RETURN VALUES' and 'E=
RRORS.'
> 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

--=20
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

--ZPt4rx8FFjLCG7dd
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQE+y71AXY6L6fI4GtQRAtLhAKDChRbWeeE6nanPX0BOuT+3j2aw+gCgrRGc
RiEaxYPucg9Lc6X7jEUfP+4=
=AfEj
-----END PGP SIGNATURE-----

--ZPt4rx8FFjLCG7dd--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030521175411.GA3076>