From owner-freebsd-doc@FreeBSD.ORG Tue Aug 16 21:50:15 2005 Return-Path: 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 97EFA16A41F for ; Tue, 16 Aug 2005 21:50:15 +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 342FE43D46 for ; Tue, 16 Aug 2005 21:50:15 +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 j7GLoFkM098330 for ; Tue, 16 Aug 2005 21:50:15 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j7GLoFjj098329; Tue, 16 Aug 2005 21:50:15 GMT (envelope-from gnats) Date: Tue, 16 Aug 2005 21:50:15 GMT Message-Id: <200508162150.j7GLoFjj098329@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Giorgos Keramidas 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 List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 16 Aug 2005 21:50:15 -0000 The following reply was made to PR docs/84956; it has been noted by GNATS. From: Giorgos Keramidas To: "Gary W. Swearingen" Cc: bug-followup@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" 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