docs/84956: [patch] intro(5) manpage doesn't mention API coverage

[Giorgos Keramidas]

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

From: Giorgos Keramidas <keramida at freebsd.org>
To: "Gary W. Swearingen" <garys at opusnet.com>
Cc: bug-followup at 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 at 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