Man pages .Dd (was: cvs commit: src/share/man/man9 uio.9)

[Ruslan Ermilov]

On Thu, Nov 30, 2006 at 03:37:12PM +0300, Gleb Smirnoff wrote:
> On Thu, Nov 30, 2006 at 10:11:57AM +1030, Greg 'groggy' Lehey wrote:
> G> On Wednesday, 29 November 2006 at 20:24:57 +0000, Alfred Perlstein wrote:
> G> > alfred      2006-11-29 20:24:57 UTC
> G> >
> G> >   FreeBSD src repository
> G> >
> G> >   Modified files:
> G> >     share/man/man9       uio.9
> G> >   Log:
> G> >   Bump .Dd, (9 year jump!)
> G> >
> G> >   Requested by: ru
> G> 
> G> This happened to me too last week.  I'm hazy about when, but my
> G> understanding has been that in the past .Dd *didn't* automatically get
> G> updated.  When should it be, when shouldn't it be?  If it should be
> G> automatic, we should write a macro which sets it from $FreeBSD$.
> 
> No. Only text changes bump .Dd. Style, spelling, wording and markup
> do not.
> 
Sometimes even editorial changes are so large that deserve a bump.
A common sense actually applies, but for content changes we usually
want to bump the date.  The comment in the example manpages is
supposed to hint about this:

.\" $FreeBSD: src/share/examples/mdoc/example.4,v 1.21.2.2 2006/06/05 19:31:57 brueffer Exp $
.\"
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
.Dd April 1, 2006

> Also, when change is merged the .Dd is left from the original
> commit to HEAD, not the date of the MFC.
> 
This is true (most of the time ;-).


Cheers,
-- 
Ruslan Ermilov
ru at FreeBSD.org
FreeBSD committer
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/cvs-src/attachments/20061130/955ccfc2/attachment.pgp