Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 28 Apr 2001 14:10:17 +0300
From:      Ruslan Ermilov <ru@FreeBSD.ORG>
To:        Mike Pritchard <mpp@mppsystems.com>
Cc:        cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG
Subject:   Re: cvs commit: src/share/doc/papers/memfs Makefile src/share/misc mdoc.template src/share/man/man7 Makefile man.7 mdoc.7 mdoc.samples.7 src/share/examples/mdoc example.1 example.3 example.4
Message-ID:  <20010428141016.B65625@sunbay.com>
In-Reply-To: <20010428055232.A54517@mppsystems.com>; from mpp@mppsystems.com on Sat, Apr 28, 2001 at 05:52:32AM -0500
References:  <200104261713.f3QHDUU90290@freefall.freebsd.org> <20010428055232.A54517@mppsystems.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Apr 28, 2001 at 05:52:32AM -0500, Mike Pritchard wrote:
> On Thu, Apr 26, 2001 at 10:13:30AM -0700, Ruslan Ermilov wrote:
> > ru          2001/04/26 10:13:29 PDT
> > 
> >   Modified files:        (Branch: RELENG_4)
> >     share/examples/mdoc  example.1 example.3 example.4 
> [...]
> >   Log:
> >   MFC: Upgrade to Groff 1.17.
> >   
> >   Revision  Changes    Path
> >   1.12.2.4  +3 -7      src/share/examples/mdoc/example.1
> >   1.12.2.5  +4 -8      src/share/examples/mdoc/example.3
> >   1.10.2.3  +3 -7      src/share/examples/mdoc/example.4
> 
> I missed this on the first go round, but in the example
> man pages, they had comments that read like so:
> 
> .\" Note: Only specify the operating system when the command
> .\" is FreeBSD specific, otherwise use the .Os macro with no
> .\" arguments.
> 
> These were removed by this MFC, and presumabliy by the original
> commit.
> 
> I think the comments are still valid, although with how we are doing 
> man pages these days, I might re-word it so it might be better:
> 
> Note:  Only specify the operating system and version when 
> the command is FreeBSD specific, or when it is documenting a 
> deprecated interface.
> 
Nope, one should not use arguments to the .Os call anymore,
they are computed automatically.  For -CURRENT, this will be
FreeBSD 5.0, for -STABLE this will be FreeBSD 4.3 for the
moment.

> And maybe for those few man pages that are actually documenting
> obsoleted interfaces, they should have an "OBSOLETE" header right
> at the start of the man page.
> 
Any examples of where this would be required would be great.
I see plenty of manpages in lib/libc/compat-43/ that say they
are obsolete.  But even in these manpages, .Os should be empty.


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?20010428141016.B65625>