Re: mdoc.7: tweak skeleton file

[Thomas Klausner <wiz@NetBSD.org>]

On Sun, Aug 29, 2010 at 10:10:13AM +0100, Jason McIntyre wrote:
> but i'm willing to bet that no netbsd pages ever changed to follow this
> difference, and EXIT STATUS is still where it always was. netbsd's own
> man page checker, mdoclint, still reflects this. furthermore it is
> oblivious to the concept of a ("wanky", in kristaps' words)
> IMPLEMENTATION NOTES section.
> 
> here is the section and ordering mdoclint follows (correct me if i'm
> wrong, thomas):
> 
> 	my @sections = (
> 		"NAME",
> 		NETBSD ? "LIBRARY" : undef,
> 		"SYNOPSIS",
> 		"DESCRIPTION",
> 		"EXIT STATUS",
> 		"RETURN VALUES",
> 		"ENVIRONMENT",
> 		"FILES",
> 		"EXAMPLES",
> 		"DIAGNOSTICS",
> 		"ERRORS",
> 		"SEE ALSO",
> 		"STANDARDS",
> 		"HISTORY",
> 		"AUTHORS",
> 		"CAVEATS",
> 		"BUGS",
> 		NETBSD ? "SECURITY CONSIDERATIONS" : undef
> 	);

Well, here's the correction. That's the order currently checked by
pkgsrc/textproc/mdoclint/files/mdoclint:
        my @sections = (
                "NAME",
                NETBSD ? "LIBRARY" : undef,
                "SYNOPSIS",
                "DESCRIPTION",
                "IMPLEMENTATION NOTES",
                "RETURN VALUES",
                "ENVIRONMENT",
                "FILES",
                "EXIT STATUS",
                "EXAMPLES",
                "DIAGNOSTICS",
                "COMPATIBILITY",
                "ERRORS",
                "SEE ALSO",
                "STANDARDS",
                "HISTORY",
                "AUTHORS",
                "CAVEATS",
                "BUGS",
                NETBSD ? "SECURITY CONSIDERATIONS" : undef
        );

(Btw, pages actually using IMPLEMENTATION NOTES are e.g. bdes(1),
which compares to Sun's implementation; or stdio(3), which mentions
which functions are macros or support locking.)

Cheers,
 Thomas
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv