Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 1 Oct 2001 11:41:53 +0300
From:      Ruslan Ermilov <ru@FreeBSD.org>
To:        Greg Lehey <grog@FreeBSD.org>
Cc:        cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org
Subject:   Re: cvs commit: src/usr.bin/calendar calendar.1
Message-ID:  <20011001114153.A4250@sunbay.com>
In-Reply-To: <20011001180443.X31215@wantadilla.lemis.com>; from grog@FreeBSD.org on Mon, Oct 01, 2001 at 06:04:43PM %2B0930
References:  <200110010235.f912ZqW96382@freefall.freebsd.org> <20011001100857.F91045@sunbay.com> <20011001174710.W31215@wantadilla.lemis.com> <20011001112916.H91045@sunbay.com> <20011001180443.X31215@wantadilla.lemis.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Oct 01, 2001 at 06:04:43PM +0930, Greg Lehey wrote:
> On Monday,  1 October 2001 at 11:29:16 +0300, Ruslan Ermilov wrote:
> > On Mon, Oct 01, 2001 at 05:47:10PM +0930, Greg Lehey wrote:
> >> On Monday,  1 October 2001 at 10:08:57 +0300, Ruslan Ermilov wrote:
> >>> On Sun, Sep 30, 2001 at 07:35:52PM -0700, Greg Lehey wrote:
> >>>> grog        2001/09/30 19:35:52 PDT
> >>>>
> >>>>   Modified files:
> >>>>     usr.bin/calendar     calendar.1
> >>>>   Log:
> >>>>   Add description for calendar.freebsd.
> >>>>
> >>>>   Revision  Changes    Path
> >>>>   1.23      +3 -1      src/usr.bin/calendar/calendar.1
> >>>
> >>> FreeBSD is to be spelled ".Fx" in mdoc(7).
> >>
> >> That doesn't work on other systems, and even on FreeBSD it only tends
> >> to obfuscate.
> >
> > This works on other systems that use the compatible version of
> > the mdoc(7) macro package distributed with Groff.
> 
> Precisely.  What's the advantage?
> 
.Fx uses a special font/size and prevents undesirable hyphenation.
When used with the version argument, it also checks the version.

> >>> Also, you forgot to update document date.
> >>
> >> My understanding was that the document date had nothing to do with
> >> when it was updated.  Can you state the policy?
> >>
> > This is from share/examples/mdoc:
> >
> > .\" Note: The date here should be updated whenever a non-trivial
> > .\" change is made to the manual page.
> 
> This change was trivial.
> 
I myself consider the following changes trivial: markup and/or spelling
fixes.  If you change the content, OTOH, e.g. you document new option or
new functionality, or add a paragpraph about functionality that wasn't
previously documented, you should bump document date.

Note "should" but not "must".  This is because if you don't do this,
I will.  :-)


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011001114153.A4250>