docs/84955: [patch] mdoc(7) manpage should mention missing documentation in BUGS
Gary W. Swearingen
garys at opusnet.com
Mon Aug 15 15:40:10 UTC 2005
>Number: 84955
>Category: docs
>Synopsis: [patch] mdoc(7) manpage should mention missing documentation in
BUGS
>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:08 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator: Gary W. Swearingen
>Release: FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:
The mdoc(7) manpage section "Miscellaneous Macros" discusses
poorly-documneted macros.
Also, the "Keeps" subsection says "More work needs to be done..."
>How-To-Repeat:
n/a
>Fix:
Rather than filing PRs on these (to be suspended or left open
forever), just make note of the problems in the BUGS section:
--- mdoc..orig.7 Sat Aug 6 13:19:51 2005
+++ mdoc.7 Sat Aug 6 13:25:01 2005
@@ -4086,6 +4086,15 @@
.Pp
The list and display macros do not do any keeps
and certainly should be able to.
+.Pp
+The "keep" macros need more work.
+See the
+.Sx Keeps
+subsection.
+.Pp
+The whole
+.Sx "MISCELLANEOUS MACROS"
+section documents more bugs in this manual page.
.\" Note what happens if the parameter list overlaps a newline
.\" boundary.
.\" to make sure a line boundary is crossed:
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list