From 8166b4e0bc220e759aa233af54ac1e60cc510f0c Mon Sep 17 00:00:00 2001 From: Dan Book Date: Sun, 22 Dec 2019 17:13:31 -0500 Subject: Update documentation, readmes, comments, and utilities to reference the GitHub issue tracker The perlbug utility and perlbug@perl.org should no longer be used to submit bug reports or patches. --- utils/h2xs.PL | 4 ++-- utils/perlbug.PL | 50 ++++++++++++++++++++------------------------------ 2 files changed, 22 insertions(+), 32 deletions(-) (limited to 'utils') diff --git a/utils/h2xs.PL b/utils/h2xs.PL index 19f60e39d0..428fb98256 100644 --- a/utils/h2xs.PL +++ b/utils/h2xs.PL @@ -1999,7 +1999,7 @@ $generate_code __END__ gave unexpected error $@ Please report the circumstances of this bug in h2xs version $H2XS_VERSION -using the perlbug script. +using the issue tracker at https://github.com/Perl/perl5/issues. EOM } else { my $fail; @@ -2020,7 +2020,7 @@ the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname correctly. Please report the circumstances of this bug in h2xs version $H2XS_VERSION -using the perlbug script. +using the issue tracker at https://github.com/Perl/perl5/issues. EOM } else { unlink $constscfname, $constsxsfname; diff --git a/utils/perlbug.PL b/utils/perlbug.PL index f54843fa20..3a55fa7c2b 100644 --- a/utils/perlbug.PL +++ b/utils/perlbug.PL @@ -1278,7 +1278,7 @@ B =head1 DESCRIPTION -This program is designed to help you generate and send bug reports +This program is designed to help you generate bug reports (and thank-you notes) about perl5 and the modules which ship with it. In most cases, you can just run it interactively from a command @@ -1290,17 +1290,16 @@ non-core module (such as Tk, DBI, etc), then please see the documentation that came with that distribution to determine the correct place to report bugs. -If you are unable to send your report using B (most likely -because your system doesn't have a way to send mail that perlbug -recognizes), you may be able to use this tool to compose your report -and save it to a file which you can then send to B -using your regular mail client. +Bug reports should be submitted to the GitHub issue tracker at +L. The B +address no longer automatically opens tickets. You can use this tool +to compose your report and save it to a file which you can then submit +to the issue tracker. In extreme cases, B may not work well enough on your system to guide you through composing a bug report. In those cases, you -may be able to use B to get system configuration -information to include in a manually composed bug report to -B. +may be able to use B or B to get system +configuration information to include in your issue report. When reporting a bug, please run through this checklist: @@ -1374,7 +1373,7 @@ Be sure to include the B error messages, if any. If you get a core dump (or equivalent), you may use a debugger (B, B, etc) to produce a stack trace to include in the bug -report. +report. NOTE: unless your Perl has been compiled with debug info (often B<-g>), the stack trace is likely to be somewhat hard to use @@ -1393,9 +1392,11 @@ will help a great deal. In other words, try to analyze the problem If so, that's great news; bug reports with patches are likely to receive significantly more attention and interest than those without -patches. Please attach your patch to the report using the C<-p> option. -When sending a patch, create it using C if possible, -though a unified diff created with C will do nearly as well. +patches. Please submit your patch via the GitHub Pull Request workflow +as described in B L. You may also send patches to +B. When sending a patch, create it using +C if possible, though a unified diff created with +C will do nearly as well. Your patch may be returned with requests for changes, or requests for more detailed explanations about your fix. @@ -1410,21 +1411,6 @@ same style as the code you are trying to patch. Make sure your patch really does work (C, if the thing you're patching is covered by Perl's test suite). -=item Can you use C to submit the report? - -B will, amongst other things, ensure your report includes -crucial information about your version of perl. If C is -unable to mail your report after you have typed it in, you may have -to compose the message yourself, add the output produced by C and email it to B. If, for some reason, you -cannot run C at all on your system, be sure to include the -entire output produced by running C (note the uppercase V). - -Whether you use C or send the email manually, please make -your Subject line informative. "a bug" is not informative. Neither -is "perl crashes" nor is "HELP!!!". These don't help. A compact -description of what's wrong is fine. - =item Can you use C to submit a thank-you note? Yes, you can do this by either using the C<-T> option, or by invoking @@ -1433,6 +1419,10 @@ smile. =back +Please make your issue title informative. "a bug" is not informative. +Neither is "perl crashes" nor is "HELP!!!". These don't help. A compact +description of what's wrong is fine. + Having done your bit, please be prepared to wait, to be told the bug is in your code, or possibly to get no reply at all. The volunteers who maintain Perl are busy folks, so if your problem is @@ -1441,8 +1431,8 @@ a duplicate of an existing report, you may not receive a personal reply. If it is important to you that your bug be fixed, do monitor the -perl5-porters@perl.org mailing list (mailing lists are moderated, your -message may take a while to show up) and the commit logs to development +issue tracker (you will be subscribed to notifications for issues you +submit or comment on) and the commit logs to development versions of Perl, and encourage the maintainers with kind words or offers of frosty beverages. (Please do be kind to the maintainers. Harassing or flaming them is likely to have the opposite effect of the -- cgit v1.2.1