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

Gary W. Swearingen garys at opusnet.com
Mon Aug 15 15:40:10 UTC 2005


>Number:         84956
>Category:       docs
>Synopsis:       [patch] intro(5) manpage doesn't mention API coverage
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Aug 15 15:40:09 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:

The intro(5) manpage doesn't mention that some APIs are
documented in section 5 too.  E.g., link(5) & acct(5)

It also has an seemingly-extraneous reference to intro(8).

>How-To-Repeat:
n/a

>Fix:

--- 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
>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list