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: Wed, 17 Aug 2005 00:44:49 +0300

 On 2005-08-15 08:38, "Gary W. Swearingen" <garys at opusnet.com> wrote:
 > --- 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
 >  .Sh FILES
 >  .Bl -tag -width /etc/shells -compact
 >  .It Pa /etc
 
 I've been trying to find a good way to write down the same information
 without the inline parentheses and the need to quote ".h" with something
 like:
 
 	.Dq Li \&.h
 
 Does this look ok to you Gary?  I've removed the reference to ".h" files
 only because people who know enough about C already don't need to know
 this and people who don't know enough about C aren't (usually)
 interested in what the specific meaning of "API .h files" is.
 
 Here's the diff:
 
 % Index: intro.5
 % ===================================================================
 % RCS file: /home/ncvs/src/share/man/man5/intro.5,v
 % retrieving revision 1.7
 % diff -u -r1.7 intro.5
 % --- intro.5	21 Jan 2005 08:36:39 -0000	1.7
 % +++ intro.5	16 Aug 2005 21:39:15 -0000
 % @@ -38,7 +38,10 @@
 %  .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 Interface
 % +.Pq API
 % +files.
 %  .Sh FILES
 %  .Bl -tag -width /etc/shells -compact
 %  .It Pa /etc
 
 If this looks ok to you, I'll commit it.  Otherwise, I'll have to let
 other, more mdoc-savvy people handle this.
 
 - Giorgos