Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 16 Aug 2001 10:27:37 -0400 (EDT)
From:      Robert Watson <rwatson@FreeBSD.org>
To:        Sheldon Hearn <sheldonh@starjuice.net>
Cc:        Greg Lehey <grog@FreeBSD.org>, Ruslan Ermilov <ru@FreeBSD.org>, Alexander Langer <alex@big.endian.de>, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org, Bruce Evans <bde@zeta.org.au>
Subject:   Re: "Rules" in documentation (was: cvs commit: src/bin/pwd pwd.1 src/bin/sh sh.1 src/gnu/usr.bin/man/manpath manpath.man src/lib/libc/db/man mpool.3 src/lib/libc/net getaddrinfo.3 getipnodebyname.3 src/lib/libc/posix1e acl.3 cap.3 cap_get_proc.3 posix1e.3 ...) 
Message-ID:  <Pine.NEB.3.96L.1010816102625.84244E-100000@fledge.watson.org>
In-Reply-To: <7507.997953894@axl.seasidesoftware.co.za>

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

On Thu, 16 Aug 2001, Sheldon Hearn wrote:

> On Thu, 16 Aug 2001 10:43:02 +0930, Greg Lehey wrote:
> 
> > If a man page writer has a particular reason for a specific sequence,
> > I don't think other people should go in and change it.
> 
> As both a reader and writer of manual pages, I don't like that.  I like
> consistency in the SEE ALSO section so that I don't have to think as
> much when I scan it for something I suspect might be there. 

BTW, in the sorting of SEE ALSO sections in my larger man pages, I tend to
use the man page section of the cross-reference as the primary sorting
key, followed by case-insensitive remainder.  That way if I
cross-reference commands, kernel functions, and libraries, they end up
sorted usefully, rather than mixed up.  That could just be me, however.
:-)

Robert N M Watson             FreeBSD Core Team, TrustedBSD Project
robert@fledge.watson.org      NAI Labs, Safeport Network Services



To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.NEB.3.96L.1010816102625.84244E-100000>