Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 17 Aug 2001 10:08:55 +0930
From:      Greg Lehey <grog@FreeBSD.org>
To:        Warner Losh <imp@harmony.village.org>
Cc:        Sheldon Hearn <sheldonh@starjuice.net>, 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:  <20010817100855.A50416@wantadilla.lemis.com>
In-Reply-To: <200108161547.f7GFlmW33386@harmony.village.org>; from imp@harmony.village.org on Thu, Aug 16, 2001 at 09:47:48AM -0600
References:  <7507.997953894@axl.seasidesoftware.co.za> <200108161547.f7GFlmW33386@harmony.village.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thursday, 16 August 2001 at  9:47:48 -0600, Warner Losh wrote:
> In message <7507.997953894@axl.seasidesoftware.co.za> Sheldon Hearn writes:
>>> 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.

At some point we'll get down to personal preferences, of course.  As
you know, there's a lot that I don't like about the current layout.

> I'd like to see things in alphabetical order, unless there's a real
> compelling reason not to.  And if there is a reason, it should be
> documented.  Otherwise, how do you tell the sloppy manual writer(s)
> from the clever, but obscure?

Agreed.  Otherwise we'll end up with another thread like this one.
But the documentation should probably be in comments.

Greg
--
See complete headers for address and phone numbers

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?20010817100855.A50416>