From: Thomas Klausner <wiz@NetBSD.org>
To: discuss@mdocml.bsd.lv
Subject: Re: mdoc section ordering
Date: Fri, 14 May 2010 00:23:01 +0200 [thread overview]
Message-ID: <20100513222301.GQ27722@danbala.tuwien.ac.at> (raw)
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
prev parent reply other threads:[~2010-05-13 18:34 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-11 11:52 Ulrich Spörlein
2010-05-11 13:45 ` Jason McIntyre
2010-05-11 14:57 ` Ulrich Spörlein
2010-05-11 15:43 ` Jason McIntyre
2010-05-11 16:23 ` Ulrich Spörlein
2010-05-11 20:09 ` Kristaps Dzonsons
2010-05-11 20:27 ` Ulrich Spörlein
2010-05-11 20:59 ` Jason McIntyre
2010-05-12 12:50 ` Kristaps Dzonsons
2010-05-13 22:23 ` Thomas Klausner [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100513222301.GQ27722@danbala.tuwien.ac.at \
--to=wiz@netbsd.org \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).