Re: mdoc.7: tweak skeleton file

[Jason McIntyre <jmc@kerhand.co.uk>]

On Mon, Aug 30, 2010 at 01:16:04PM +0100, Jason McIntyre wrote:
> On Mon, Aug 30, 2010 at 11:01:15AM +0200, Thomas Klausner wrote:
> > 
> > > yes, so are netbsd going to move EXIT STATUS in all pages to the place
> > > now advertised by mandoc/mdoclint or are you going to put EXIT STATUS
> > > immediately after DESCRIPTION again?
> > 
> > Well, I prefer the place next to RETURN VALUES (because those two are
> > quite similar in my eyes) but we can settle on the other one, and I'll
> > update the pages over the years ;)
> >  Thomas
> 
> i guess it will be less fuss to accept where it is now than to change it
> again. i'll keep to the new order as well then.
> 
> i'll inline below what i currently have in the sections part of
> mdoclint. can you check yours agrees?
> 

and just so there's no confusion, i've inlined the actual commits i made
to man.7 and mandoc.7 (in the openbsd tree).

jmc

Index: man/man7/man.7
===================================================================
RCS file: /cvs/src/share/man/man7/man.7,v
retrieving revision 1.7
diff -u -r1.7 man.7
--- man/man7/man.7	22 Aug 2010 11:39:18 -0000	1.7
+++ man/man7/man.7	31 Aug 2010 17:47:58 -0000
@@ -221,23 +221,25 @@
 \efBfoo\efR \e(en a description goes here
 \&.\e\*q The next is for sections 2 & 3 only.
 \&.\e\*q .SH LIBRARY
+\&.\e\*q Not used in OpenBSD.
 \&.SH SYNOPSIS
 \efBfoo\efR [\efB\e-options\efR] arguments...
 \&.SH DESCRIPTION
 The \efBfoo\efR utility processes files...
 \&.\e\*q .SH IMPLEMENTATION NOTES
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.
 \&.\e\*q .SH RETURN VALUES
-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .SH ENVIRONMENT
+\&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .SH FILES
-\&.\e\*q The next is for sections 1 & 8 only.
 \&.\e\*q .SH EXIT STATUS
+\&.\e\*q For sections 1 & 8 only.
 \&.\e\*q .SH EXAMPLES
-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .SH DIAGNOSTICS
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .SH ERRORS
+\&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .SH SEE ALSO
 \&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS
@@ -246,6 +248,7 @@
 \&.\e\*q .SH CAVEATS
 \&.\e\*q .SH BUGS
 \&.\e\*q .SH SECURITY CONSIDERATIONS
+\&.\e\*q Not used in OpenBSD.
 .Ed
 .Pp
 The sections in a
Index: man/man7/mdoc.7
===================================================================
RCS file: /cvs/src/share/man/man7/mdoc.7,v
retrieving revision 1.49
diff -u -r1.49 mdoc.7
--- man/man7/mdoc.7	22 Aug 2010 11:39:18 -0000	1.49
+++ man/man7/mdoc.7	31 Aug 2010 17:48:00 -0000
@@ -331,8 +331,9 @@
 \&.Sh NAME
 \&.Nm foo
 \&.Nd a description goes here
-\&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .Sh LIBRARY
+\&.\e\*q For sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.
 \&.Sh SYNOPSIS
 \&.Nm foo
 \&.Op Fl options
@@ -342,18 +343,19 @@
 \&.Nm
 utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q Not used in OpenBSD.
 \&.\e\*q .Sh RETURN VALUES
-\&.\e\*q The next is for sections 1, 6, 7, & 8 only.
+\&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .Sh ENVIRONMENT
+\&.\e\*q For sections 1, 6, 7, & 8 only.
 \&.\e\*q .Sh FILES
-\&.\e\*q The next is for sections 1, 6 & 8 only.
 \&.\e\*q .Sh EXIT STATUS
+\&.\e\*q For sections 1 & 8 only.
 \&.\e\*q .Sh EXAMPLES
-\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .Sh DIAGNOSTICS
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q For sections 1, 4, 6, 7, & 8 only.
 \&.\e\*q .Sh ERRORS
+\&.\e\*q For sections 2, 3, & 9 only.
 \&.\e\*q .Sh SEE ALSO
 \&.\e\*q .Xr foobar 1
 \&.\e\*q .Sh STANDARDS
@@ -362,6 +364,7 @@
 \&.\e\*q .Sh CAVEATS
 \&.\e\*q .Sh BUGS
 \&.\e\*q .Sh SECURITY CONSIDERATIONS
+\&.\e\*q Not used in OpenBSD.
 .Ed
 .Pp
 The sections in an
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv