Re: mdoc.7: tweak skeleton file

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

On Sun, Aug 29, 2010 at 02:09:38PM +0200, Thomas Klausner wrote:
> On Sun, Aug 29, 2010 at 12:32:46PM +0059, Jason McIntyre wrote:
> > grr, we were meant to keep these files in sync. can you please mail me
> > when you make changes to this?
> 
> I'm sorry. I changed this after the discussion in May, here's the
> diff:
> @@ -104,12 +104,14 @@
>                 NETBSD ? "LIBRARY" : undef,
>                 "SYNOPSIS",
>                 "DESCRIPTION",
> -               NETBSD ? "EXIT STATUS" : undef,
> +               "IMPLEMENTATION NOTES",
>                 "RETURN VALUES",
>                 "ENVIRONMENT",
>                 "FILES",
> +               NETBSD ? "EXIT STATUS" : undef,
>                 "EXAMPLES",
>                 "DIAGNOSTICS",
> +               "COMPATIBILITY",
>                 "ERRORS",
>                 "SEE ALSO",
>                 "STANDARDS",
> 
> Actually, I don't like the new place of EXIT STATUS and prefer the old
> one; very few pages have been changed to the new order (only those
> with other commits since May).
>  Thomas

well, there is nothing to say we have to move it at all. it can stay in the
place it always was.

however for openbsd, the choice is not so important - we currently don;t
have EXIT STATUS, so as far as workload goes, it's irrelevant where we add
it.

i personally think it is best placed immediately after DESCRIPTION,
where it always was. please let us not just think about what posix does
when making this decision. i'd welcome feedback from any freebsd people
at this point - maybe there was a good reason for the change.

anyway, my diff below should make us match (almost) for mdoclint. note
that you need to make "IMPLEMENTATION NOTES" defined for netbsd only,
and "EXIT STATUS" now not os-specific.

let me know what you want to do about section placement.
jmc

Index: mdoclint
===================================================================
RCS file: /cvs/src/regress/usr.bin/mdoclint/mdoclint,v
retrieving revision 1.16
diff -u -r1.16 mdoclint
--- mdoclint	10 Feb 2010 08:36:33 -0000	1.16
+++ mdoclint	29 Aug 2010 16:10:45 -0000
@@ -104,12 +104,14 @@
 		NETBSD ? "LIBRARY" : undef,
 		"SYNOPSIS",
 		"DESCRIPTION",
-		NETBSD ? "EXIT STATUS" : undef,
+		NETBSD ? "IMPLEMENTATION NOTES" : undef,
 		"RETURN VALUES",
 		"ENVIRONMENT",
 		"FILES",
+		"EXIT STATUS",
 		"EXAMPLES",
 		"DIAGNOSTICS",
+		NETBSD ? "COMPATIBILITY" : undef,
 		"ERRORS",
 		"SEE ALSO",
 		"STANDARDS",
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv