From: Kristaps Dzonsons <kristaps@bsd.lv>
To: "discuss@mdocml.bsd.lv" <discuss@mdocml.bsd.lv>
Subject: Re: mdoc section ordering
Date: Tue, 11 May 2010 22:09:49 +0200 [thread overview]
Message-ID: <4BE9B98D.3060706@bsd.lv> (raw)
In-Reply-To: <20100511162352.GY88504@acme.spoerlein.net>
> I'm fine with that, only then mandoc should stop "enforcing" this
> ordering. It's perfectly fine with me!
>
> Kristaps, what to you think?
Seems the consensus is to roll with the FreeBSD version, which is fine
by me. The sections were originally unioned over all mdoc.template and
man.template files I could find. I didn't sweat the order.
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?
Jason, in my opinion, COMPATIBILITY and STANDARDS shouldn't be merged in
all cases. Take mdocml's man.7 and mdoc.7, for example: the
COMPATIBILITY section is used to enumerate the differences between
troffs and mandoc. Since -man, -mdoc, etc. aren't standards, where else
would this go?
Anyway, if everybody ok's this order, I'll commit it and add the
requisite bits to the docs.
Ulrich, you said you know of a handful of mis-ordered NetBSD pages. Can
you post those to Joerg? He'll probably want to know about them (will
your python script auto-gen a patch for him?).
Thanks,
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2010-05-11 16:21 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 [this message]
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
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=4BE9B98D.3060706@bsd.lv \
--to=kristaps@bsd.lv \
--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).