Re: mdoc.7: tweak skeleton file

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

On Sun, Aug 29, 2010 at 12:08:44AM +0200, Kristaps Dzonsons wrote:
> >>I like the idea of moving the "next section..." stuff.  I always 
> >>hiccuped on that.
> >>
> >>But it makes more sense to say "not OpenBSD" than "for x, y, and z only" 
> >>because the latter covers an open interval.
> >>
> >>Enclosed is a patch that uses "not OpenBSD".
> >>
> >>Thoughts?
> >>
> >>If it's good, I'll put it in man.7 also.
> >>
> >>Kristaps
> >
> >aye. ok too.
> 
> Done.  Got mdoc.7, man.7, and mdoc.template fixed up.
> 

oops, except all our section ordering is mad. is this diff correct?
please note some very suble changes ;(

on a side note, there is an IMPLEMENTATION NOTES section, which is not
recognised by us or mdoclint. can we kill it?

jmc

Index: misc/mdoc.template
===================================================================
RCS file: /cvs/src/share/misc/mdoc.template,v
retrieving revision 1.10
diff -u -r1.10 mdoc.template
--- misc/mdoc.template	31 May 2007 22:10:19 -0000	1.10
+++ misc/mdoc.template	28 Aug 2010 22:38:21 -0000
@@ -19,16 +19,18 @@
 .Nm
 utility processes files ...
 .\" The following requests should be uncommented and used where appropriate.
-.\" This next request is for sections 2, 3, and 9 function return values only.
+.\" .Sh EXIT STATUS
+.\" For sections 1, 6, & 8 only.
 .\" .Sh RETURN VALUES
-.\" This next request is for sections 1, 6, 7 & 8 only.
+.\" For sections 2, 3, and 9 function return values only.
 .\" .Sh ENVIRONMENT
+.\" For sections 1, 6, 7 & 8 only.
 .\" .Sh FILES
 .\" .Sh EXAMPLES
-.\" This next request is for sections 1, 4, 6, and 8 only.
 .\" .Sh DIAGNOSTICS
-.\" The next request is for sections 2, 3, and 9 error and signal handling only.
+.\" For sections 1, 4, 6, 7, and 8 only.
 .\" .Sh ERRORS
+.\" For sections 2, 3, and 9 error and signal handling only.
 .\" .Sh SEE ALSO
 .\" .Xr foobar 1
 .\" .Sh STANDARDS
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	28 Aug 2010 22:38:21 -0000
@@ -221,23 +221,24 @@
 \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 .SH EXIT STATUS
+\&.\e\*q For sections 1, 6, & 8 only.
 \&.\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 .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 +247,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	28 Aug 2010 22:38:23 -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,18 @@
 \&.Nm
 utility processes files ...
 \&.\e\*q .Sh IMPLEMENTATION NOTES
-\&.\e\*q The next is for sections 2, 3, & 9 only.
+\&.\e\*q .Sh EXIT STATUS
+\&.\e\*q For sections 1, 6, & 8 only.
 \&.\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 .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 +363,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