From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Re: mdoc EXIT STATUS (Was: pending open issues)
Date: Fri, 06 Aug 2010 18:36:47 +0200 [thread overview]
Message-ID: <4C5C3A1F.8090603@bsd.lv> (raw)
In-Reply-To: <20100806161706.GA30025@iris.usta.de>
>>>> the exchange of information and opinions where to best put exit status
>>>> documentation for section 1, 6, and 8 manuals seems unfinished to me;
>>>> if i understand correctly, what FreeBSD and DragonFly want and do is
>>>> plain enough (EXIT STATUS), but in NetBSD and OpenBSD, i find such
>>>> information sometimes in DESCRIPTION, sometimes in DIAGNOSTICS.
>
>>> Well, NetBSD never went over all the man pages, but the general
>>> consensus for new ones is to use EXIT STATUS. I would make that the
>>> recommendation for new man pages.
>
>> I'm fine with this patch, given Joerg's note that Nx uses EXIT
>> STATUS along with the others...
>
> Um, i have dropped this patch, given Joerg's note that Nx uses EXIT
> STATUS along with the others... ;-)
>
> Remeber, my abandoned patch said:
>
> Others, for example
> .Nx
> and
> .Ox ,
> show the same information in the
> .Em DIAGNOSTICS
> section or near the end of the
> .Em DESCRIPTION .
I mean by "given Joerg's note" that the `Nx' could be bumped up, in your
patch, alongside the `Fx' and `Dx' macros and conform to what Joerg said.
> We have not made a final decision yet, but we are seriously
> considering to switch OpenBSD to use EXIT STATUS as well, even
> though that means we will have to adapt a bit more than 1000 manuals,
> and even though a section with a single sentence will not look
> that pretty. But there are two arguments in favour of EXIT STATUS:
> It makes finding that bit of information really easy, and it's good
> when you don't need to learn different conventions for each system.
That would probably make things best in the long run, I agree.
Thanks,
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2010-08-06 16:36 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <4C4E0F7B.4030009@bsd.lv>
[not found] ` <20100727071224.GB7946@bramka.kerhand.co.uk>
2010-07-27 8:31 ` pending open issues Kristaps Dzonsons
2010-07-27 9:00 ` Sascha Wildner
2010-07-27 9:20 ` Jason McIntyre
2010-07-27 9:32 ` Kristaps Dzonsons
2010-07-27 9:41 ` Jason McIntyre
2010-07-27 10:03 ` Kristaps Dzonsons
2010-07-27 10:18 ` Jason McIntyre
2010-07-27 11:21 ` mdoc EXIT STATUS (Was: pending open issues) Kristaps Dzonsons
[not found] ` <20100727131709.GA16499@edoofus.dev.vega.ru>
2010-07-27 13:54 ` Kristaps Dzonsons
2010-07-27 14:15 ` Jason McIntyre
[not found] ` <20100728123317.GA43609@edoofus.dev.vega.ru>
2010-07-28 13:38 ` Jason McIntyre
2010-08-03 21:28 ` Ingo Schwarze
2010-08-03 21:34 ` Joerg Sonnenberger
2010-08-06 15:48 ` Kristaps Dzonsons
2010-08-06 16:17 ` Ingo Schwarze
2010-08-06 16:36 ` Kristaps Dzonsons [this message]
2010-08-04 6:57 ` Jason McIntyre
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=4C5C3A1F.8090603@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).