cvs commit: src/share/examples/ses/getencstat getencstat.0 src/share/examples/ses/sesd sesd.0 src/share/examples/ses/setencstat setencstat.0 src/share/examples/ses/setobjstat setobjstat.0 src/shar

[Bruce Evans]

On Wed, 9 Feb 2005, Ceri Davies wrote:

> On Wed, Feb 09, 2005 at 06:07:17PM +0000, Ruslan Ermilov wrote:
> > ru          2005-02-09 18:07:17 UTC
> >
> >   FreeBSD src repository
> >
> >   Modified files:
> >   ...
> >     share/man/man9       VOP_ACLCHECK.9 acl.9 microtime.9 mutex.9
> >                          style.9 tvtohz.9 vfs_unmountall.9
                             ^^^^^^^
> >   Log:
> >   Fixed the misplaced $FreeBSD$.
>
> style(9) doesn't say anything about this - could you add something
> please?

style.9 says a lot about this for C programs, and used to say something
about this for man pages by example: $FreeBSD$ goes immediately after
the vendor id.  However, the example doesn't obviously apply to man
pages because it is in a form suitable for C headers (a C comment),
though it was intended to be a self-referential example for the man
page itself.  The vendor id in it had to be misplaced to not set a bad
example by moving the vendor id, and the $FreeBSD$ in it had to be
misplaced to not set a bad example by placing it elsewhere than after
the vendor id.

Now there is another buggy example in the comment at the top of the
man page.  The new bugs are not having the vendor id there, and
incompleteness -- the example can only be seen by reading the source
file.

style.9 is special since it has to give self-referential examples.  It
needs at least 1 more $FreeBSD$ and 1 or 2 more vendor ids to obviously
cover man pages:
- a literal vendor id and $FreeBSD$ pair in the form of a man page comment
- maybe another vendor id before the $FreeBSD$ in the comment at the top
  of the man page.  This is not quite right because style.9 isn't really
  a man page and the vendor didn't put the id there.

Bruce