From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from danbala.tuwien.ac.at (danbala.ifoer.tuwien.ac.at [128.130.168.64])
	by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id o4DIY6JQ014319
	for <discuss@mdocml.bsd.lv>; Thu, 13 May 2010 12:34:08 -0600 (MDT)
Received: by danbala.tuwien.ac.at (Postfix, from userid 116)
	id E78E5390933; Fri, 14 May 2010 00:23:01 +0200 (MEST)
Date: Fri, 14 May 2010 00:23:01 +0200
From: Thomas Klausner <wiz@NetBSD.org>
To: discuss@mdocml.bsd.lv
Subject: Re: mdoc section ordering
Message-ID: <20100513222301.GQ27722@danbala.tuwien.ac.at>
References: <20100511115233.GV88504@acme.spoerlein.net>
 <20100511134542.GA24992@bramka.kerhand.co.uk>
 <20100511145711.GW88504@acme.spoerlein.net>
 <20100511154317.GB24992@bramka.kerhand.co.uk>
 <20100511162352.GY88504@acme.spoerlein.net>
 <sfid-+20100511-221023-+007.41-1@spamfilter.osbf.lua>
 <4BE9B98D.3060706@bsd.lv>
X-Mailinglist: mdocml-discuss
Reply-To: discuss@mdocml.bsd.lv
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <4BE9B98D.3060706@bsd.lv>

On Tue, May 11, 2010 at 10:09:49PM +0200, Kristaps Dzonsons wrote:
> End result:
> 
> .Sh NAME
> .Sh LIBRARY
> .Sh SYNOPSIS
> .Sh DESCRIPTION
> .Sh IMPLEMENTATION NOTES  <-- this one seems wankiest to me
> .Sh RETURN VALUES
> .Sh ENVIRONMENT
> .Sh FILES
> .Sh EXIT STATUS
> .Sh EXAMPLES
> .Sh DIAGNOSTICS
> .Sh COMPATIBILITY
> .Sh ERRORS
> .Sh SEE ALSO
> .Sh STANDARDS
> .Sh HISTORY
> .Sh AUTHORS
> .Sh CAVEATS
> .Sh BUGS
> .Sh SECURITY CONSIDERATIONS  <-- shouldn't this be CAVEATS?

The order that's hardcoded in mdoclint (used for checking man pages,
not only for the section order, by jmc@openbsd and myself) is

.Sh NAME
.Sh LIBRARY
.Sh SYNOPSIS
.Sh DESCRIPTION
.Sh EXIT STATUS /* NetBSD only */
.Sh RETURN VALUES
.Sh ENVIRONMENT
.Sh FILES
.Sh EXAMPLES
.Sh DIAGNOSTICS
.Sh ERRORS
.Sh SEE ALSO
.Sh STANDARDS
.Sh HISTORY
.Sh AUTHORS
.Sh CAVEATS
.Sh BUGS
.Sh SECURITY CONSIDERATIONS /* NetBSD only */

i.e. EXIT STATUS is seen as an alternate to RETURN VALUES and put next
to that; and COMPATIBILITY and IMPLEMENTATION NOTES are not defined as
standard sections.

Except for EXIT STATUS, the proposed order is fine with me; not sure
if we should define the COMPATIBILITY and IMPLEMENTATION NOTES as
standard or not, but I don't really care. We'll probably have to fix
some man pages for the order in that case, but that's fine with me.
 Thomas
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv