Skip to content

Commit 8166b4e

Browse files
Grinnzkhwilliamson
authored andcommittedDec 22, 2019
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.
1 parent 08ab6dc commit 8166b4e

36 files changed

+125
-141
lines changed
 

‎AUTHORS

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# (hopefully) current and preferred email addresses from the commits.
44
# These people have either submitted patches or suggestions, or their bug
55
# reports or comments have inspired the appropriate patches. Corrections,
6-
# additions, deletions welcome; send them to perlbug@perl.org, preferably
6+
# additions, deletions welcome; send them as a pull request to
7+
# https://github.com/Perl/perl5, or to perl5-porters@perl.org, preferably
78
# as the output of diff(1), diff -u or diff -c between the original and a
89
# corrected version of this file.
910
#

‎Configure

+7-7
Original file line numberDiff line numberDiff line change
@@ -1537,8 +1537,8 @@ case "$sh" in
15371537
$me: Fatal Error: I can't find a Bourne Shell anywhere.
15381538

15391539
Usually it's in /bin/sh. How did you even get this far?
1540-
Please contact me (Perl Maintainers) at perlbug@perl.org and
1541-
we'll try to straighten this all out.
1540+
Please contact me (Perl Maintainers) at https://github.com/Perl/perl5/issues
1541+
and we'll try to straighten this all out.
15421542
EOM
15431543
exit 1
15441544
;;
@@ -2121,7 +2121,7 @@ THIS PACKAGE SEEMS TO BE INCOMPLETE.
21212121
You have the option of continuing the configuration process, despite the
21222122
distinct possibility that your kit is damaged, by typing 'y'es. If you
21232123
do, don't blame me if something goes wrong. I advise you to type 'n'o
2124-
and contact the author (perlbug@perl.org).
2124+
and contact the author (https://github.com/Perl/perl5/issues).
21252125

21262126
EOM
21272127
echo $n "Continue? [n] $c" >&4
@@ -2401,7 +2401,7 @@ Much effort has been expended to ensure that this shell script will run on any
24012401
Unix system. If despite that it blows up on yours, your best bet is to edit
24022402
Configure and run it again. If you can't run Configure for some reason,
24032403
you'll have to generate a config.sh file by hand. Whatever problems you
2404-
have, let me (perlbug@perl.org) know how I blew it.
2404+
have, let me (https://github.com/Perl/perl5/issues) know how I blew it.
24052405

24062406
This installation script affects things in two ways:
24072407

@@ -3370,7 +3370,7 @@ EOM
33703370
(cd $src/hints; ls -C *.sh) | $sed 's/\.sh/ /g' >&4
33713371
dflt=''
33723372
: Half the following guesses are probably wrong... If you have better
3373-
: tests or hints, please send them to perlbug@perl.org
3373+
: tests or hints, please send them to https://github.com/Perl/perl5/issues
33743374
: The metaconfig authors would also appreciate a copy...
33753375
$test -f /irix && osname=irix
33763376
$test -f /xenix && osname=sco_xenix
@@ -5788,7 +5788,7 @@ compile='
57885788
mc_file=$1;
57895789
shift;
57905790
case "$usedevel" in $define|true|[yY]*) if $test ! -f "${mc_file}.c"; then
5791-
echo "Internal Configure script bug - compiler test file ${mc_file}.c is missing. Please report this to perlbug@perl.org" >&4;
5791+
echo "Internal Configure script bug - compiler test file ${mc_file}.c is missing. Please report this to https://github.com/Perl/perl5/issues" >&4;
57925792
exit 1;
57935793
fi;
57945794
esac;
@@ -8784,7 +8784,7 @@ case "$shrpdir" in
87848784
*) $cat >&4 <<EOM
87858785
WARNING: Use of the shrpdir variable for the installation location of
87868786
the shared $libperl is not supported. It was never documented and
8787-
will not work in this version. Let me (perlbug@perl.org)
8787+
will not work in this version. Let me (https://github.com/Perl/perl5/issues)
87888788
know of any problems this may cause.
87898789

87908790
EOM

‎INSTALL

+21-26
Original file line numberDiff line numberDiff line change
@@ -2384,30 +2384,28 @@ settings"> above.
23842384

23852385
=head1 Reporting Problems
23862386

2387-
Wherever possible please use the perlbug tool supplied with this Perl
2388-
to report problems, as it automatically includes summary configuration
2389-
information about your perl, which may help us track down problems far
2390-
more quickly. But first you should read the advice in this file,
2391-
carefully re-read the error message and check the relevant manual pages
2392-
on your system, as these may help you find an immediate solution.
2393-
Once you've exhausted the documentation, please report bugs to us using
2394-
the 'perlbug' tool.
2395-
2396-
The perlbug tool is installed along with perl, so after you have
2397-
completed C<make install> it should be possible to run it with plain
2398-
C<perlbug>. If the install fails, or you want to report problems with
2399-
C<make test> without installing perl, then you can use C<make nok> to
2400-
run perlbug to report the problem, or run it by hand from this source
2401-
directory with C<./perl -Ilib utils/perlbug>
2402-
2403-
If the build fails too early to run perlbug uninstalled, then please
2404-
B<run> the C<./myconfig> shell script, and mail its output along with
2405-
an accurate description of your problem to perlbug@perl.org
2387+
Please report problems to the GitHub issue tracker at
2388+
https://github.com/Perl/perl5/issues, which will ask for the
2389+
appropriate summary configuration information about your perl, which
2390+
may help us track down problems far more quickly. But first you should
2391+
read the advice in this file, carefully re-read the error message and
2392+
check the relevant manual pages on your system, as these may help you
2393+
find an immediate solution. Once you've exhausted the documentation,
2394+
please report bugs to us using the GitHub tracker.
2395+
2396+
The summary configuration information can be printed with C<perl -V>.
2397+
If the install fails, or you want to report problems with C<make test>
2398+
without installing perl, then you can run it by hand from this source
2399+
directory with C<./perl -V>.
2400+
2401+
If the build fails too early to run perl, then please
2402+
B<run> the C<./myconfig> shell script, and include its output along
2403+
with an accurate description of your problem.
24062404

24072405
If Configure itself fails, and does not generate a config.sh file
2408-
(needed to run C<./myconfig>), then please mail perlbug@perl.org the
2406+
(needed to run C<./myconfig>), then please open an issue with the
24092407
description of how Configure fails along with details of your system
2410-
-- for example the output from running C<uname -a>
2408+
-- for example the output from running C<uname -a>.
24112409

24122410
Please try to make your message brief but clear. Brief, clear bug
24132411
reports tend to get answered more quickly. Please don't worry if your
@@ -2420,13 +2418,10 @@ config.sh or a complete Configure or make log) unless absolutely
24202418
necessary. Do not include a complete transcript of your build
24212419
session. Just include the failing commands, the relevant error
24222420
messages, and whatever preceding commands are necessary to give the
2423-
appropriate context. Plain text should usually be sufficient -- fancy
2424-
attachments or encodings may actually reduce the number of people who
2425-
read your message. Your message will get relayed to over 400
2426-
subscribers around the world so please try to keep it brief but clear.
2421+
appropriate context.
24272422

24282423
If the bug you are reporting has security implications which make it
2429-
inappropriate to send to a publicly archived mailing list, then see
2424+
inappropriate to send to a public issue tracker, then see
24302425
L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
24312426
for details of how to report the issue.
24322427

‎Porting/how_to_write_a_perldelta.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ for the particular file in core.)
165165

166166
=item Utility Changes
167167

168-
Changes to installed programs such as F<perlbug> and F<xsubpp> go here. Most
168+
Changes to installed programs such as F<perldoc> and F<xsubpp> go here. Most
169169
of these are built within the directory F<utils>.
170170

171171
=item New Documentation

‎Porting/perldelta_template.pod

+7-8
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ XXX Description of the purpose of the new file here
157157
=head2 Changes to Existing Documentation
158158

159159
We have attempted to update the documentation to reflect the changes
160-
listed in this document. If you find any we have missed, send email
161-
to L<perlbug@perl.org|mailto:perlbug@perl.org>.
160+
listed in this document. If you find any we have missed, open an issue
161+
at L<https://github.com/Perl/perl5/issues>.
162162

163163
XXX Changes which significantly change existing files in F<pod/> go here.
164164
However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
@@ -224,7 +224,7 @@ XXX Describe change here
224224

225225
=head1 Utility Changes
226226

227-
XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
227+
XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
228228
Most of these are built within the directory F<utils>.
229229

230230
[ List utility changes as a =head2 entry for each utility and =item
@@ -411,13 +411,12 @@ If you find what you think is a bug, you might check the perl bug database
411411
at L<https://github.com/Perl/perl5/issues>. There may also be information at
412412
L<http://www.perl.org/>, the Perl Home Page.
413413

414-
If you believe you have an unreported bug, please run the L<perlbug> program
415-
included with your release. Be sure to trim your bug down to a tiny but
416-
sufficient test case. Your bug report, along with the output of C<perl -V>,
417-
will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
414+
If you believe you have an unreported bug, please open an issue at
415+
L<https://github.com/Perl/perl5/issues>. Be sure to trim your bug down to a
416+
tiny but sufficient test case.
418417

419418
If the bug you are reporting has security implications which make it
420-
inappropriate to send to a publicly archived mailing list, then see
419+
inappropriate to send to a public issue tracker, then see
421420
L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
422421
for details of how to report the issue.
423422

‎Porting/pod_lib.pl

+1-1
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ =head2 C<get_pod_metadata()>
547547
information about various types of POD files.
548548
549549
'aux' => [ # utility programs like
550-
'h2xs' and 'perlbug' ]
550+
'h2xs' and 'perldoc' ]
551551
'generated' => { # lookup table for generated POD files
552552
like 'perlapi.pod' }
553553
'ignore' => { # lookup table for files to be ignored }

‎Porting/release_managers_guide.pod

+1-3
Original file line numberDiff line numberDiff line change
@@ -1109,9 +1109,7 @@ Test L<perlbug> with the following:
11091109
Action (Send/Display/Edit/Subject/Save to File): Q
11101110

11111111
and carefully examine the output (in F<perlbug.rep]>), especially
1112-
the "Locally applied patches" section. If everything appears okay, then
1113-
delete the file, and try it again, this time actually submitting the bug
1114-
report. Check that it shows up, then remember to close it!
1112+
the "Locally applied patches" section.
11151113

11161114
=for checklist skip BLEAD-POINT
11171115

‎README

+1-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@ Perl is a large and complex system that's used for everything from
6161
knitting to rocket science. If you run into trouble, it's quite
6262
likely that someone else has already solved the problem you're
6363
facing. Once you've exhausted the documentation, please report bugs to us
64-
using the 'perlbug' tool. For more information about perlbug, either type
65-
'perldoc perlbug' or just 'perlbug' on a line by itself.
64+
at the GitHub issue tracker at https://github.com/Perl/perl5/issues
6665

6766
While it was current when we made it available, Perl is constantly evolving
6867
and there may be a more recent version that fixes bugs you've run into or

‎README.bs2000

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ about pod in pod/perlpod.pod or the short summary in the INSTALL file.
88
perlbs2000 - building and installing Perl for BS2000.
99

1010
B<This document needs to be updated, but we don't know what it should say.
11-
Please email comments to L<perlbug@perl.org|mailto:perlbug@perl.org>.>
11+
Please submit comments to L<https://github.com/Perl/perl5/issues>.>
1212

1313
=head1 SYNOPSIS
1414

‎README.freebsd

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,6 @@ C<argv[0]> value for C<$^X>.
3636
Nicholas Clark <nick@ccl4.org>, collating wisdom supplied by Slaven Rezic
3737
and Tim Bunce.
3838

39-
Please report any errors, updates, or suggestions to L<mailto:perlbug@perl.org>.
39+
Please report any errors, updates, or suggestions to
40+
L<https://github.com/Perl/perl5/issues>.
4041

‎README.irix

+2-1
Original file line numberDiff line numberDiff line change
@@ -134,5 +134,6 @@ at least the shuffle.t and sort.t failures.
134134

135135
Jarkko Hietaniemi <jhi@iki.fi>
136136

137-
Please report any errors, updates, or suggestions to F<perlbug@perl.org>.
137+
Please report any errors, updates, or suggestions to
138+
L<https://github.com/Perl/perl5/issues>.
138139

‎README.linux

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,6 @@ is needed to get this working better.
3535

3636
Steve Peters <steve@fisharerojo.org>
3737

38-
Please report any errors, updates, or suggestions to F<perlbug@perl.org>.
38+
Please report any errors, updates, or suggestions to
39+
L<https://github.com/Perl/perl5/issues>.
3940

‎README.macosx

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ on G5-based hosts.
122122

123123
Support for 64-bit addressing is experimental: some aspects of Perl may be
124124
omitted or buggy. Note the messages output by F<Configure> for further
125-
information. Please use C<perlbug> to submit a problem report in the
126-
event that you encounter difficulties.
125+
information. Please use L<https://github.com/Perl/perl5/issues> to submit a
126+
problem report in the event that you encounter difficulties.
127127

128128
When building 64-bit modules, it is your responsibility to ensure that linked
129129
external libraries and frameworks provide 64-bit support: if they do not,

‎README.openbsd

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@ will run into this problem. If you want to run a threaded Perl on OpenBSD
2626

2727
Steve Peters <steve@fisharerojo.org>
2828

29-
Please report any errors, updates, or suggestions to F<perlbug@perl.org>.
29+
Please report any errors, updates, or suggestions to
30+
L<https://github.com/Perl/perl5/issues>.
3031

‎README.os390

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This document will help you Configure, build, test and install Perl
1313
on OS/390 (aka z/OS) Unix System Services.
1414

1515
B<This document needs to be updated, but we don't know what it should say.
16-
Please email comments to L<perlbug@perl.org|mailto:perlbug@perl.org>.>
16+
Please submit comments to L<https://github.com/Perl/perl5/issues>.>
1717

1818
=head1 DESCRIPTION
1919

‎README.os400

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ designed to be readable as is.
77
perlos400 - Perl version 5 on OS/400
88

99
B<This document needs to be updated, but we don't know what it should say.
10-
Please email comments to L<perlbug@perl.org|mailto:perlbug@perl.org>.>
10+
Please submit comments to L<https://github.com/Perl/perl5/issues>.>
1111

1212
=head1 DESCRIPTION
1313

‎README.solaris

+2-1
Original file line numberDiff line numberDiff line change
@@ -709,4 +709,5 @@ The original was written by Andy Dougherty F<doughera@lafayette.edu>
709709
drawing heavily on advice from Alan Burlison, Nick Ing-Simmons, Tim Bunce,
710710
and many other Solaris users over the years.
711711

712-
Please report any errors, updates, or suggestions to F<perlbug@perl.org>.
712+
Please report any errors, updates, or suggestions to
713+
L<https://github.com/Perl/perl5/issues>.

‎README.vms

+3-4
Original file line numberDiff line numberDiff line change
@@ -467,10 +467,9 @@ of the GNU cc headers.
467467
=head1 Reporting Bugs
468468

469469
If you come across what you think might be a bug in Perl, please report
470-
it. There's a script in PERL_ROOT:[UTILS], perlbug, that walks you through
471-
the process of creating a bug report. This script includes details of your
472-
installation, and is very handy. Completed bug reports should go to
473-
perlbug@perl.org.
470+
it. The issue tracker at L<https://github.com/Perl/perl5/issues> walks you
471+
through the process of creating a bug report and including details of your
472+
installation.
474473

475474
=head1 CAVEATS
476475

‎README.win32

+6-7
Original file line numberDiff line numberDiff line change
@@ -685,8 +685,8 @@ or any invocation of make.
685685
If a module does not build for some reason, look carefully for
686686
why it failed, and report problems to the module author. If
687687
it looks like the extension building support is at fault, report
688-
that with full details of how the build failed using the perlbug
689-
utility.
688+
that with full details of how the build failed using the GitHub
689+
issue tracker at L<https://github.com/Perl/perl5/issues>.
690690

691691
=item Command-line Wildcard Expansion
692692

@@ -874,9 +874,8 @@ executable built during the installation process. Usage is exactly
874874
the same as normal C<perl> on Windows, except that options like C<-h>
875875
don't work (since they need a command-line window to print to).
876876

877-
If you find bugs in perl, you can run C<perlbug> to create a
878-
bug report (you may have to send it manually if C<perlbug> cannot
879-
find a mailer on your system).
877+
If you find bugs in perl, you can report them to
878+
L<https://github.com/Perl/perl5/issues>.
880879

881880
=head1 BUGS AND CAVEATS
882881

@@ -924,8 +923,8 @@ variable in the handler. Using signals under this port should
924923
currently be considered unsupported.
925924

926925
Please send detailed descriptions of any problems and solutions that
927-
you may find to E<lt>F<perlbug@perl.org>E<gt>, along with the output
928-
produced by C<perl -V>.
926+
you may find to E<lt>L<https://github.com/Perl/perl5/issues>E<gt>,
927+
along with the output produced by C<perl -V>.
929928

930929
=head1 ACKNOWLEDGEMENTS
931930

‎hints/README.hints

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ can't or doesn't guess properly. Most of these hint files have been
99
tested with at least some version of perl5, but some are still left
1010
over from perl4.
1111

12-
Please send any problems or suggested changes to perlbug@perl.org.
12+
Please send any problems or suggested changes to
13+
L<https://github.com/Perl/perl5/issues>.
1314

1415
=head1 Hint file naming convention.
1516

‎hints/bsdos.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ $define|true|[yY]*)
125125
*) cat <<EOM >&4
126126
I did not know that BSD/OS $osvers supports POSIX threads.
127127
128-
Feel free to tell perlbug@perl.org otherwise.
128+
Feel free to tell https://github.com/Perl/perl5/issues otherwise.
129129
EOM
130130
exit 1
131131
;;

‎hints/freebsd.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ $define|true|[yY]*)
207207
0.*|1.*|2.0*|2.1*) cat <<EOM >&4
208208
I did not know that FreeBSD $osvers supports POSIX threads.
209209
210-
Feel free to tell perlbug@perl.org otherwise.
210+
Feel free to tell https://github.com/Perl/perl5/issues otherwise.
211211
EOM
212212
exit 1
213213
;;

‎pod/perl.pod

+2-4
Original file line numberDiff line numberDiff line change
@@ -428,11 +428,9 @@ displayed by diagnostics are internally stored as short integers,
428428
so they are limited to a maximum of 65535 (higher numbers usually being
429429
affected by wraparound).
430430

431-
You may mail your bug reports (be sure to include full configuration
431+
You may submit your bug reports (be sure to include full configuration
432432
information as output by the myconfig program in the perl source
433-
tree, or by C<perl -V>) to perlbug@perl.org . If you've succeeded
434-
in compiling perl, the L<perlbug> script in the F<utils/> subdirectory
435-
can be used to help mail in a bug report.
433+
tree, or by C<perl -V>) to L<https://github.com/Perl/perl5/issues>.
436434

437435
Perl actually stands for Pathologically Eclectic Rubbish Lister, but
438436
don't tell anyone I said that.

0 commit comments

Comments
 (0)