]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
CONTRIBUTING, CONTRIBUTING.d/bugs, README: Split CONTRIBUTING file
authorAlejandro Colomar <alx@kernel.org>
Sat, 3 Feb 2024 20:48:49 +0000 (21:48 +0100)
committerAlejandro Colomar <alx@kernel.org>
Sat, 3 Feb 2024 21:53:10 +0000 (22:53 +0100)
Signed-off-by: Alejandro Colomar <alx@kernel.org>
CONTRIBUTING
CONTRIBUTING.d/bugs [new file with mode: 0644]
README

index c113803fb2c68ca1f401339256de77e8173b05f4..ed7434b03c5b88f072f9c318f9640ab205006903 100644 (file)
@@ -3,7 +3,7 @@ Name
 
 Synopsis
        Mailing list, patches, lint & check, style guide, bug reports,
-       and notes
+       and more.
 
 Description
    Mailing list
@@ -191,26 +191,6 @@ Description
        groff_man_style(7) for understanding and writing good man(7)
        source code.
 
-Reporting bugs
-       Report bugs to the mailing list, following the instructions above
-       for sending mails to the list.  If you can write a patch (see
-       instructions for sending patches above), it's preferred.
-
-       If you're unsure if the bug is in the manual page or in the code
-       being documented (kernel, glibc, ...), it's best to send the
-       report to both at the same time, that is, CC all the mailing
-       lists that may be concerned by the report.
-
-       Some distributions (for example Debian) apply patches to the
-       upstream manual pages.  If you suspect the bug is in one of those
-       patches, report it to your distribution maintainer.
-
-       Send logically separate reports.  For unrelated pages, or for
-       logically-separate issues in the same page, send separate emails.
-
-       There's also a bugzilla, but we don't use it as much as the
-       mailing list.
-
 Notes
    External and autogenerated pages
        A few pages come from external sources.  Fixes to the pages
@@ -223,11 +203,9 @@ Notes
        using scripts.  See man-pages commits 53666f6c3 and 19c7f7839 for
        details.
 
-Bugs
-   Bugzilla:
-       <https://bugzilla.kernel.org/buglist.cgi?component=man-pages>
-
 See also
+       CONTRIBUTING.d/bugs
+
        man-pages(7)
 
        <https://www.kernel.org/doc/man-pages/linux-man-ml.html>
diff --git a/CONTRIBUTING.d/bugs b/CONTRIBUTING.d/bugs
new file mode 100644 (file)
index 0000000..4b8cf74
--- /dev/null
@@ -0,0 +1,28 @@
+Name
+       Bugs - instructions for reporting bugs
+
+Description
+       Report bugs to the mailing list.  If you can write a patch, it's
+       very welcome.
+
+       If you're unsure if the bug is in the manual page or in the code
+       being documented (kernel, glibc, ...), it's best to send the
+       report to both at the same time, that is, CC all the mailing
+       lists that may be concerned by the report.
+
+       Some distributions (for example Debian) apply patches to the
+       upstream manual pages.  If you suspect the bug is in one of those
+       patches, report it to your distribution maintainer.
+
+       Send logically separate reports.  For unrelated pages, or for
+       logically-separate issues in the same page, send separate emails.
+
+       There's also a bugzilla, but we don't use it as much as the
+       mailing list.  If you want to track your bug there, feel free to
+       open a bug report, but expect more attention in the mailing list.
+
+See also
+       CONTRIBUTING
+       CONTRIBUTING.d/*
+
+       <https://bugzilla.kernel.org/buglist.cgi?component=man-pages>
diff --git a/README b/README
index 115e9f53abb843fde1aa114707305c07468409f2..62f9ca8700eb03ec2f498affebaf5a22187d5a53 100644 (file)
--- a/README
+++ b/README
@@ -17,6 +17,7 @@ Description
 
 Files
    CONTRIBUTING
+   CONTRIBUTING.d/*
        Instructions for reporting bugs and contributing.
 
    INSTALL