Bug 15353

Summary:	manpage section missing from examples
Product:	Documentation	Reporter:	David E. O'Brien <obrien>
Component:	Books & Articles	Assignee:	mpp
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description David E. O'Brien freebsd_committer

1999-12-08 06:10:00 UTC

	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).

Comment 1 Alexey M. Zelkin 1999-12-08 07:57:46 UTC

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 */

Comment 2 mpp freebsd_committer

1999-12-08 21:11:54 UTC

Responsible Changed
From-To: freebsd-doc->mpp

I'll look into this one.

Comment 3 mpp freebsd_committer

1999-12-08 22:17:53 UTC

State Changed
From-To: open->closed

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.