From owner-cvs-all  Sat Apr 28  3:52:40 2001
Delivered-To: cvs-all@freebsd.org
Received: from mppsystems.com (mppsystems.com [208.210.148.205])
	by hub.freebsd.org (Postfix) with ESMTP
	id 6C13D37B424; Sat, 28 Apr 2001 03:52:33 -0700 (PDT)
	(envelope-from mpp@mppsystems.com)
Received: (from mpp@localhost)
	by mppsystems.com (8.11.3/8.11.3) id f3SAqWE55112;
	Sat, 28 Apr 2001 05:52:32 -0500 (CDT)
	(envelope-from mpp)
Date: Sat, 28 Apr 2001 05:52:32 -0500
From: Mike Pritchard <mpp@mppsystems.com>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
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: <20010428055232.A54517@mppsystems.com>
References: <200104261713.f3QHDUU90290@freefall.freebsd.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.2.5i
In-Reply-To: <200104261713.f3QHDUU90290@freefall.freebsd.org>; from ru@FreeBSD.ORG on Thu, Apr 26, 2001 at 10:13:30AM -0700
Sender: owner-cvs-all@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.ORG

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.

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.

-Mike
-- 
Mike Pritchard
mpp@FreeBSD.org or mpp@mppsystems.com

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