From: Michael Kerrisk <mtk.manpages@gmail.com>
Date: Thu, 21 May 2020 06:15:46 +0000 (+0200)
Subject: man-pages.7: Add REPORTING BUGS section
X-Git-Tag: man-pages-5.07~31
X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fman-pages.git;a=commitdiff_plain;h=c91a4f144c2bc170fde06b847e1ff77a17e90054

man-pages.7: Add REPORTING BUGS section

man-pages doesn't have a REPORTING BUGS section in manual pages,
but many other projects do. Make some recommendations about
placement of that section.
---

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 99c1f48d01..04b2701904 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -198,6 +198,7 @@ BUGS
 EXAMPLE
 .\" AUTHORS sections are discouraged
 AUTHORS            [Discouraged]
+REPORTING BUGS     [Not used in man-pages]
 COPYRIGHT          [Not used in man-pages]
 \fBSEE ALSO\fP
 .fi
@@ -453,6 +454,15 @@ add a copyright notice as a comment in the source file.
 If you are the author of a device driver and want to include
 an address for reporting bugs, place this under the BUGS section.
 .TP
+.B REPORTING BUGS
+The
+.IR man-pages
+project doesn't use a REPORTING BUGS section in manual pages.
+Information on reporting bugs is instead supplied in the
+script-generated COLOPHON section.
+However, various projects do use a REPORTING BUGS section.
+it is recommended to place it near the foot of the page.
+.TP
 .B COPYRIGHT
 The
 .IR man-pages