Re: mdoc.7: tweak skeleton file

["Ulrich Spörlein" <uqs@spoerlein.net>]

On Sun, 29.08.2010 at 19:26:20 +0200, Kristaps Džonsons wrote:
> > 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.
> 
> Note that Ruslan, whom I understand does a lot of FreeBSD manual stuff, 
> isn't part of this list.  So if you want to involve him, you'll have to 
> CC him...

I can't speak with any authority on this topic, as it far predates my
mdoc involvement.

But this is the blessed ordering for the FreeBSD manpages, where EXIT
STATUS was taken (and ordered) from the POSIX manpages.

sections = [
    '00',
    'NAME',
    'LIBRARY',
    'SYNOPSIS',
    'DESCRIPTION',
    'IMPLEMENTATION NOTES',
    'RETURN VALUES',
    'ENVIRONMENT',
    'FILES',
    'EXIT STATUS',
    'EXAMPLES',
    'DIAGNOSTICS',
    'COMPATIBILITY',
    'ERRORS',
    'SEE ALSO',
    'STANDARDS',
    'HISTORY',
    'AUTHORS',
    'CAVEATS',
    'BUGS',
    'SECURITY CONSIDERATIONS',
]
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv