discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
* EXIT STATUS for section 6
@ 2010-09-03 12:57 ` Jason McIntyre
  2010-09-03 16:29   ` Thomas Klausner
  0 siblings, 1 reply; 6+ messages in thread
From: Jason McIntyre @ 2010-09-03 12:57 UTC (permalink / raw)
  To: discuss

the templates say EXIT STATUS is for sections 1 and 8. the descriptions
of EXIT STATUS say it is for sections 1, 6, and 8. which is it?

openbsd has no exit status info in any of its section 6 pages. ok?
jmc

Index: man.7
===================================================================
RCS file: /cvs/src/share/man/man7/man.7,v
retrieving revision 1.8
diff -u -r1.8 man.7
--- man.7	31 Aug 2010 17:51:31 -0000	1.8
+++ man.7	3 Sep 2010 12:56:15 -0000
@@ -306,7 +306,7 @@
 the file is used (created, modified, etc.).
 .It Em EXIT STATUS
 This section documents the command exit status for
-section 1, 6, and 8 utilities.
+section 1 and 8 utilities.
 Historically, this information was described in
 .Em DIAGNOSTICS ,
 a practise that is now discouraged.
Index: mdoc.7
===================================================================
RCS file: /cvs/src/share/man/man7/mdoc.7,v
retrieving revision 1.50
diff -u -r1.50 mdoc.7
--- mdoc.7	31 Aug 2010 17:51:31 -0000	1.50
+++ mdoc.7	3 Sep 2010 12:56:18 -0000
@@ -518,7 +518,7 @@
 .Sx \&Pa .
 .It Em EXIT STATUS
 This section documents the
-command exit status for section 1, 6, and 8 utilities.
+command exit status for section 1 and 8 utilities.
 Historically, this information was described in
 .Em DIAGNOSTICS ,
 a practise that is now discouraged.
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: EXIT STATUS for section 6
  2010-09-03 12:57 ` EXIT STATUS for section 6 Jason McIntyre
@ 2010-09-03 16:29   ` Thomas Klausner
  2010-09-03 19:28     ` Jason McIntyre
  0 siblings, 1 reply; 6+ messages in thread
From: Thomas Klausner @ 2010-09-03 16:29 UTC (permalink / raw)
  To: discuss

On Fri, Sep 03, 2010 at 01:57:19PM +0100, Jason McIntyre wrote:
> the templates say EXIT STATUS is for sections 1 and 8. the descriptions
> of EXIT STATUS say it is for sections 1, 6, and 8. which is it?

Section 6 are games, so they could have an EXIT STATUS.

> openbsd has no exit status info in any of its section 6 pages. ok?

Well, I thought you're only introducing EXIT STATUS in the OpenBSD man
pages? :)

Anyway, i don't see any EXIT STATUS in man6/* on NetBSD either.

I think we should allow it for section 6 as well, but I don't care
much either way.
 Thomas
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: EXIT STATUS for section 6
  2010-09-03 16:29   ` Thomas Klausner
@ 2010-09-03 19:28     ` Jason McIntyre
  2010-09-03 22:42       ` Ingo Schwarze
  0 siblings, 1 reply; 6+ messages in thread
From: Jason McIntyre @ 2010-09-03 19:28 UTC (permalink / raw)
  To: discuss

On Fri, Sep 03, 2010 at 06:29:05PM +0200, Thomas Klausner wrote:
> On Fri, Sep 03, 2010 at 01:57:19PM +0100, Jason McIntyre wrote:
> > the templates say EXIT STATUS is for sections 1 and 8. the descriptions
> > of EXIT STATUS say it is for sections 1, 6, and 8. which is it?
> 
> Section 6 are games, so they could have an EXIT STATUS.
> 

could have, yeah. but don't.

> > openbsd has no exit status info in any of its section 6 pages. ok?
> 
> Well, I thought you're only introducing EXIT STATUS in the OpenBSD man
> pages? :)
> 

yeah. but i downcased EXIT STATUS - i meant none of the section 6pages
have any info about what they return.

> Anyway, i don't see any EXIT STATUS in man6/* on NetBSD either.
> 
> I think we should allow it for section 6 as well, but I don't care
> much either way.

right, so which way do we fall. section 6 ok or not? i don't care.

jmc
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: EXIT STATUS for section 6
  2010-09-03 19:28     ` Jason McIntyre
@ 2010-09-03 22:42       ` Ingo Schwarze
  2010-09-04  6:52         ` Jason McIntyre
  0 siblings, 1 reply; 6+ messages in thread
From: Ingo Schwarze @ 2010-09-03 22:42 UTC (permalink / raw)
  To: discuss

Hi Jason, hi Thomas,

Jason McIntyre wrote on Fri, Sep 03, 2010 at 08:28:07PM +0100:
> On Fri, Sep 03, 2010 at 06:29:05PM +0200, Thomas Klausner wrote:
> > On Fri, Sep 03, 2010 at 01:57:19PM +0100, Jason McIntyre wrote:

>>> the templates say EXIT STATUS is for sections 1 and 8. the descriptions
>>> of EXIT STATUS say it is for sections 1, 6, and 8. which is it?

>> Section 6 are games, so they could have an EXIT STATUS.

> could have, yeah. but don't.

For some cases, that's a documentation bug.
Take fortune(6) -m.  The EXIT STATUS tells whether there were matches,
which ought to be documented.
Or try /usr/games/banner -w xxx BSD ; echo $?

>>> openbsd has no exit status info in any of its section 6 pages. ok?

>> Well, I thought you're only introducing EXIT STATUS in the OpenBSD man
>> pages? :)

> yeah. but i downcased EXIT STATUS - i meant none of the section 6pages
> have any info about what they return.

Some should.

NB: I don't blame you that they don't.  But it's a task to read the
program sources and find out whether each one should.

>> Anyway, i don't see any EXIT STATUS in man6/* on NetBSD either.
>> 
>> I think we should allow it for section 6 as well, but I don't care
>> much either way.

> right, so which way do we fall. section 6 ok or not? i don't care.

I'm clearly with Thomas here.  EXIT STATUS in section 6 is needed.

Yours,
  Ingo
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: EXIT STATUS for section 6
  2010-09-03 22:42       ` Ingo Schwarze
@ 2010-09-04  6:52         ` Jason McIntyre
  2010-09-04 17:22           ` Kristaps Dzonsons
  0 siblings, 1 reply; 6+ messages in thread
From: Jason McIntyre @ 2010-09-04  6:52 UTC (permalink / raw)
  To: discuss

On Sat, Sep 04, 2010 at 12:42:08AM +0200, Ingo Schwarze wrote:
> Hi Jason, hi Thomas,
> 
> Jason McIntyre wrote on Fri, Sep 03, 2010 at 08:28:07PM +0100:
> > On Fri, Sep 03, 2010 at 06:29:05PM +0200, Thomas Klausner wrote:
> > > On Fri, Sep 03, 2010 at 01:57:19PM +0100, Jason McIntyre wrote:
> 
> >>> the templates say EXIT STATUS is for sections 1 and 8. the descriptions
> >>> of EXIT STATUS say it is for sections 1, 6, and 8. which is it?
> 
> >> Section 6 are games, so they could have an EXIT STATUS.
> 
> > could have, yeah. but don't.
> 
> For some cases, that's a documentation bug.

agreed.

> Take fortune(6) -m.  The EXIT STATUS tells whether there were matches,
> which ought to be documented.
> Or try /usr/games/banner -w xxx BSD ; echo $?
> 
> >>> openbsd has no exit status info in any of its section 6 pages. ok?
> 
> >> Well, I thought you're only introducing EXIT STATUS in the OpenBSD man
> >> pages? :)
> 
> > yeah. but i downcased EXIT STATUS - i meant none of the section 6pages
> > have any info about what they return.
> 
> Some should.
> 
> NB: I don't blame you that they don't.  But it's a task to read the
> program sources and find out whether each one should.
> 
> >> Anyway, i don't see any EXIT STATUS in man6/* on NetBSD either.
> >> 
> >> I think we should allow it for section 6 as well, but I don't care
> >> much either way.
> 
> > right, so which way do we fall. section 6 ok or not? i don't care.
> 
> I'm clearly with Thomas here.  EXIT STATUS in section 6 is needed.
> 
> Yours,
>   Ingo

fine. so i'll commit the diff below.
jmc

Index: man/man7/man.7
===================================================================
RCS file: /cvs/src/share/man/man7/man.7,v
retrieving revision 1.8
diff -u -r1.8 man.7
--- man/man7/man.7	31 Aug 2010 17:51:31 -0000	1.8
+++ man/man7/man.7	4 Sep 2010 06:51:28 -0000
@@ -234,7 +234,7 @@
 \&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .SH FILES
 \&.\e\*q .SH EXIT STATUS
-\&.\e\*q For sections 1 & 8 only.
+\&.\e\*q For sections 1, 6, & 8 only.
 \&.\e\*q .SH EXAMPLES
 \&.\e\*q .SH DIAGNOSTICS
 \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
Index: man/man7/mdoc.7
===================================================================
RCS file: /cvs/src/share/man/man7/mdoc.7,v
retrieving revision 1.50
diff -u -r1.50 mdoc.7
--- man/man7/mdoc.7	31 Aug 2010 17:51:31 -0000	1.50
+++ man/man7/mdoc.7	4 Sep 2010 06:51:29 -0000
@@ -350,7 +350,7 @@
 \&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .Sh FILES
 \&.\e\*q .Sh EXIT STATUS
-\&.\e\*q For sections 1 & 8 only.
+\&.\e\*q For sections 1, 6, & 8 only.
 \&.\e\*q .Sh EXAMPLES
 \&.\e\*q .Sh DIAGNOSTICS
 \&.\e\*q For sections 1, 4, 6, 7, & 8 only.
Index: misc/mdoc.template
===================================================================
RCS file: /cvs/src/share/misc/mdoc.template,v
retrieving revision 1.11
diff -u -r1.11 mdoc.template
--- misc/mdoc.template	31 Aug 2010 17:51:31 -0000	1.11
+++ misc/mdoc.template	4 Sep 2010 06:51:29 -0000
@@ -25,7 +25,7 @@
 .\" For sections 1, 6, 7 & 8 only.
 .\" .Sh FILES
 .\" .Sh EXIT STATUS
-.\" For sections 1 & 8 only.
+.\" For sections 1, 6, & 8 only.
 .\" .Sh EXAMPLES
 .\" .Sh DIAGNOSTICS
 .\" For sections 1, 4, 6, 7, and 8 only.
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: EXIT STATUS for section 6
  2010-09-04  6:52         ` Jason McIntyre
@ 2010-09-04 17:22           ` Kristaps Dzonsons
  0 siblings, 0 replies; 6+ messages in thread
From: Kristaps Dzonsons @ 2010-09-04 17:22 UTC (permalink / raw)
  To: discuss

> fine. so i'll commit the diff below.
> jmc

I've merged this in BSD.lv, too.  Thanks!

Kristaps
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2010-09-04 17:23 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <sfid-H20100903-145809-+038.18-1@spamfilter.osbf.lua>
2010-09-03 12:57 ` EXIT STATUS for section 6 Jason McIntyre
2010-09-03 16:29   ` Thomas Klausner
2010-09-03 19:28     ` Jason McIntyre
2010-09-03 22:42       ` Ingo Schwarze
2010-09-04  6:52         ` Jason McIntyre
2010-09-04 17:22           ` Kristaps Dzonsons

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).