docs/84550: mdoc(7) manpage erroneously requires SYNOPSIS section

Gary W. Swearingen garys at opusnet.com
Thu Aug 4 15:20:11 UTC 2005


>Number:         84550
>Category:       docs
>Synopsis:       mdoc(7) manpage erroneously requires SYNOPSIS section
>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:   Thu Aug 04 15:20:09 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:

The "a Manual Page Template" (BTW, notice the bad capitalization) says
that the SYNOPSIS section is "required" and "mandatory", while intro(1)
.. intro(9), netstat(1), rtld(1), sigstack(2), libarchive(3), geom(4), 
<almost all>(5), tuning(7), boot(8), module(9), and many others need or
don't have a SYNOPSIS.

>How-To-Repeat:
n/a

>Fix:
Remove the requirement. Capitalize "a Manual..".
>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list