From owner-freebsd-doc@FreeBSD.ORG  Tue Aug 16 16:00:38 2005
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@hub.freebsd.org
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 080CB16A41F
	for <freebsd-doc@hub.freebsd.org>; Tue, 16 Aug 2005 16:00:38 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 6CA4843D48
	for <freebsd-doc@hub.freebsd.org>; Tue, 16 Aug 2005 16:00:35 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.13.3/8.13.3) with ESMTP id j7GG0ZXU053206
	for <freebsd-doc@freefall.freebsd.org>; Tue, 16 Aug 2005 16:00:35 GMT
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j7GG0Z8O053205;
	Tue, 16 Aug 2005 16:00:35 GMT (envelope-from gnats)
Date: Tue, 16 Aug 2005 16:00:35 GMT
Message-Id: <200508161600.j7GG0Z8O053205@freefall.freebsd.org>
To: freebsd-doc@FreeBSD.org
From: Giorgos Keramidas <keramida@freebsd.org>
Cc: 
Subject: Re: docs/84956: [patch] intro(5) manpage doesn't mention API
	coverage
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
Reply-To: Giorgos Keramidas <keramida@freebsd.org>
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 16 Aug 2005 16:00:38 -0000

The following reply was made to PR docs/84956; it has been noted by GNATS.

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <garys@opusnet.com>
Cc: bug-followup@freebsd.org
Subject: Re: docs/84956: [patch] intro(5) manpage doesn't mention API coverage
Date: Tue, 16 Aug 2005 18:56:40 +0300

 On 2005-08-15 08:38, "Gary W. Swearingen" <garys@opusnet.com> wrote:
 > The intro(5) manpage doesn't mention that some APIs are
 > documented in section 5 too.  E.g., link(5) & acct(5)
 
 Ouch!  The link(5) and acct(5) manpages seem a bit misplaced.  They
 don't describe a "file format", so they shouldn't be in section (5)
 IMHO.  There are a few other manpages in ``/usr/share/man/man5''
 that I am not sure about either.
 
 > --- intro..orig.5	Sun Aug  7 21:58:11 2005
 > +++ intro.5	Sun Aug  7 22:07:22 2005
 > @@ -38,11 +38,11 @@
 >  .Nm intro
 >  .Nd "introduction to file formats"
 >  .Sh DESCRIPTION
 > -This section contains information about file formats.
 > +This section contains information about file formats
 > +and some system Application Programming Interfaces (API .h files).
 >  .Sh SEE ALSO
 >  .Xr apropos 1 ,
 > -.Xr intro 1 ,
 > -.Xr intro 8
 > +.Xr intro 1
 
 My intuition says that anyone who is reading intro(X) manpages should be
 able to find out about all the other intro(Y) manpages.  So, it seems
 that inter-linking from any intro(X) manpage to the other intro(Y)
 manpages, where X != Y, seems reasonable.
 
 - Giorgos