From obrien@NUXI.com Tue Dec  7 22:02:22 1999
Return-Path: <obrien@NUXI.com>
Received: from relay.nuxi.com (nuxi.cs.ucdavis.edu [169.237.7.38])
	by hub.freebsd.org (Postfix) with ESMTP id 7A64C14C48
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  7 Dec 1999 22:02:22 -0800 (PST)
	(envelope-from obrien@NUXI.com)
Received: from dragon.nuxi.com (root@d60-025.leach.ucdavis.edu [169.237.60.25])
	by relay.nuxi.com (8.9.3/8.9.3) with ESMTP id WAA46750
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 7 Dec 1999 22:02:22 -0800 (PST)
	(envelope-from obrien@dragon.nuxi.com)
Received: (from obrien@localhost)
	by dragon.nuxi.com (8.9.3/8.9.1) id WAA64010;
	Tue, 7 Dec 1999 22:02:21 -0800 (PST)
	(envelope-from obrien)
Message-Id: <199912080602.WAA64010@dragon.nuxi.com>
Date: Tue, 7 Dec 1999 22:02:21 -0800 (PST)
From: obrien@freebsd.org
Sender: obrien@NUXI.com
Reply-To: obrien@freebsd.org
To: FreeBSD-gnats-submit@freebsd.org
Subject: manpage section missing from examples
X-Send-Pr-Version: 3.2

>Number:         15353
>Category:       docs
>Synopsis:       manpage section missing from examples
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    mpp
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Dec  7 22:10:00 PST 1999
>Closed-Date:    Wed Dec 8 14:17:53 PST 1999
>Last-Modified:  Wed Dec  8 14:19:38 PST 1999
>Originator:     David O'Brien
>Release:        FreeBSD 4.0-CURRENT i386
>Organization:
The FreeBSD Project
>Environment:

	

>Description:

	Some manpages like ls.1 have a "COMPATIBILITY" section.
	Where is the proper location for it?
	ls.1 has it above "SEE ALSO".  I would have guessed it should be
	before or after "STANDARDS".

>How-To-Repeat:

	

>Fix:

	Please add "COMPATIBILITY" to /usr/share/examples/mdoc/example.? and 
	doc(7).

>Release-Note:
>Audit-Trail:

From: Alexey Zelkin <phantom@cris.net>
To: obrien@FreeBSD.ORG
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/15353: manpage section missing from examples
Date: Wed, 8 Dec 1999 10:57:46 +0300

 hi,
 
 On Tue, Dec 07, 1999 at 10:02:21PM -0800, obrien@FreeBSD.ORG wrote:
  
 > >Number:         15353
 > >Category:       docs
 > >Synopsis:       manpage section missing from examples
 
 > >Description:
 > 
 > 	Some manpages like ls.1 have a "COMPATIBILITY" section.
 > 	Where is the proper location for it?
 > 	ls.1 has it above "SEE ALSO".  I would have guessed it should be
 > 	before or after "STANDARDS".
 > 
 
 > >Fix:
 > 
 > 	Please add "COMPATIBILITY" to /usr/share/examples/mdoc/example.? and 
 > 	doc(7).
 
 Quick look shown that we have about 200 nonstandalone (not listed in mdoc(7))
 sections headers. It's impossible to add all of them to mdoc(7). I not
 sure that it's good idea.
 
 -- 
 /* Alexey Zelkin                       && phantom@cris.net    */
 /* Tavric National University          && phantom@crimea.edu  */
 /* http://www.ccssu.crimea.ua/~phantom && phantom@FreeBSD.org */
 
Responsible-Changed-From-To: freebsd-doc->mpp 
Responsible-Changed-By: mpp 
Responsible-Changed-When: Wed Dec 8 13:11:54 PST 1999 
Responsible-Changed-Why:  
I'll look into this one. 
State-Changed-From-To: open->closed 
State-Changed-By: mpp 
State-Changed-When: Wed Dec 8 14:17:53 PST 1999 
State-Changed-Why:  
the COMPATIBILITY section is now documented in mdoc(7), mdoc.samples(7), 
and the example man pages in examples/mdoc. 

I placed it where it seemed like most of the current man pages 
seem to use it.   
>Unformatted:
