4 use File::Basename qw(&basename &dirname);
6 use File::Spec::Functions;
8 # List explicitly here the variables you want Configure to
9 # generate. Metaconfig only looks for shell variables, so you
10 # have to mention them as if they were shell variables, not
11 # %Config entries. Thus you write
13 # to ensure Configure will look for $Config{startperl}.
16 # This forces PL files to create target in same directory as PL file.
17 # This is so that make depend always knows where to find PL derivatives.
20 $file = basename($0, '.PL');
21 $file .= '.com' if $^O eq 'VMS';
23 open OUT, ">$file" or die "Can't create $file: $!";
25 # extract patchlevel.h information
27 open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h")
28 or die "Can't open patchlevel.h: $!";
30 my $patchlevel_date = (stat PATCH_LEVEL)[9];
32 while (<PATCH_LEVEL>) {
33 last if $_ =~ /^\s*static\s+char.*?local_patches\[\]\s*=\s*{\s*$/;
37 while (<PATCH_LEVEL>) {
43 push @patches, $_ unless $_ eq 'NULL';
45 my $patch_desc = "'" . join("',\n '", @patches) . "'";
46 my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches;
50 # TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is
51 # used, compare $Config::config_sh with the stored version. If they differ then
52 # append a list of individual differences to the bug report.
55 print "Extracting $file (with variable substitutions)\n";
57 # In this section, perl variables will be expanded during extraction.
58 # You can use $Config{...} to use Configure variables.
60 my $extract_version = sprintf("v%vd", $^V);
62 print OUT <<"!GROK!THIS!";
64 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
65 if \$running_under_some_shell;
67 my \$config_tag1 = '$extract_version - $Config{cf_time}';
69 my \$patchlevel_date = $patchlevel_date;
70 my \$patch_tags = '$patch_tags';
76 # In the following, perl variables are not expanded during extraction.
78 print OUT <<'!NO!SUBS!';
81 use File::Spec; # keep perlbug Perl 5.005 compatible
88 eval "use Mail::Send;";
89 $::HaveSend = ($@ eq "");
90 eval "use Mail::Util;";
91 $::HaveUtil = ($@ eq "");
96 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
97 # Changed in 1.07 to see more sendmail execs, and added pipe output.
98 # Changed in 1.08 to use correct address for sendmail.
99 # Changed in 1.09 to close the REP file before calling it up in the editor.
100 # Also removed some old comments duplicated elsewhere.
101 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
102 # temp filename generation.
103 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
104 # Changed in 1.12 to check for editor errors, make save/send distinction
105 # clearer and add $ENV{REPLYTO}.
106 # Changed in 1.13 to hopefully make it more difficult to accidentally
108 # Changed in 1.14 to make the prompts a little more clear on providing
109 # helpful information. Also let file read fail gracefully.
110 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
111 # Also report selected environment variables.
112 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
113 # Changed in 1.17 Win32 support added. GSAR 97-04-12
114 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
115 # Changed in 1.19 '-ok' default not '-v'
116 # add local patch information
117 # warn on '-ok' if this is an old system; add '-okay'
118 # Changed in 1.20 Added patchlevel.h reading and version/config checks
119 # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
120 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
121 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
122 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
123 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
124 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
125 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
126 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
128 # TODO: - Allow the user to re-name the file on mail failure, and
129 # make sure failure (transmission-wise) of Mail::Send is
133 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
134 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity,
135 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
137 my $perl_version = $^V ? sprintf("v%vd", $^V) : $];
139 my $config_tag2 = "$perl_version - $Config{cf_time}";
143 if ($::opt_h) { Help(); exit; }
144 if ($::opt_d) { Dump(*STDOUT); exit; }
145 if (!-t STDIN && !($ok and not $::opt_n)) {
147 Please use perlbug interactively. If you want to
148 include a file, you can use the -f switch.
152 if (!-t STDOUT && !$outfile) { Dump(*STDOUT); exit; }
155 Edit() unless $usefile || ($ok and not $::opt_n);
161 sub ask_for_alternatives {
167 Please pick a \u$name from the following:
173 my $joined_alts = join('|', @alts);
176 die "Invalid $name: aborting.\n";
178 print "Please enter a \u$name [$default]: ";
181 if ($alt =~ /^\s*$/) {
184 } while ($alt !~ /^($joined_alts)$/i);
189 # -------- Setup --------
191 $Is_MSWin32 = $^O eq 'MSWin32';
192 $Is_VMS = $^O eq 'VMS';
193 $Is_MacOS = $^O eq 'MacOS';
195 @ARGV = split m/\s+/,
196 MacPerl::Ask('Provide command-line args here (-h for help):')
197 if $Is_MacOS && $MacPerl::Version =~ /App/;
199 if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
201 # This comment is needed to notify metaconfig that we are
202 # using the $perladmin, $cf_by, and $cf_time definitions.
204 # -------- Configuration ---------
207 $perlbug = 'perlbug@perl.com';
210 $testaddress = 'perlbug-test@perl.com';
213 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
215 # Users address, used in message and in Reply-To header
216 $from = $::opt_r || "";
218 # Include verbose configuration information
219 $verbose = $::opt_v || 0;
221 # Subject of bug-report message
222 $subject = $::opt_s || "";
225 $usefile = ($::opt_f || 0);
227 # File to send as report
228 $file = $::opt_f || "";
231 $outfile = $::opt_F || "";
234 $body = $::opt_b || "";
237 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
238 || ($Is_VMS && "edit/tpu")
239 || ($Is_MSWin32 && "notepad")
243 # Not OK - provide build failure template by finessing OK report
245 if (substr($::opt_n, 0, 2) eq 'ok' ) {
246 $::opt_o = substr($::opt_n, 1);
253 # OK - send "OK" report for build on this system
256 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
257 my $age = time - $patchlevel_date;
258 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
259 my $date = localtime $patchlevel_date;
261 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
262 are more than 60 days old. This Perl version was constructed on
263 $date. If you really want to report this, use
264 "perlbug -okay" or "perlbug -nokay".
268 # force these options
270 $::opt_S = 1; # don't prompt for send
271 $::opt_b = 1; # we have a body
272 $body = "Perl reported to build OK on this system.\n";
274 $::opt_C = 1; # don't send a copy to the local admin
275 $::opt_s = 1; # we have a subject line
276 $subject = ($::opt_n ? 'Not ' : '')
277 . "OK: perl $perl_version ${patch_tags}on"
278 ." $::Config{'archname'} $::Config{'osvers'} $subject";
286 # Possible administrator addresses, in order of confidence
287 # (Note that cf_email is not mentioned to metaconfig, since
288 # we don't really want it. We'll just take it if we have to.)
290 # This has to be after the $ok stuff above because of the way
291 # that $::opt_C is forced.
292 $cc = $::opt_C ? "" : (
293 $::opt_c || $::Config{'perladmin'}
294 || $::Config{'cf_email'} || $::Config{'cf_by'}
298 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
299 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
300 : $Is_MacOS ? $ENV{'USER'}
301 : eval { getpwuid($<) }; # May be missing
303 $from = $::Config{'cf_email'}
304 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
305 ($me eq $::Config{'cf_by'});
309 # Explain what perlbug is
312 This program provides an easy way to create a message reporting a bug
313 in perl, and e-mail it to $address. It is *NOT* intended for
314 sending test messages or simply verifying that perl works, *NOR* is it
315 intended for reporting bugs in third-party perl modules. It is *ONLY*
316 a means of reporting verifiable problems with the core perl distribution,
317 and any solutions to such problems, to the people who maintain perl.
319 If you're just looking for help with perl, try posting to the Usenet
320 newsgroup comp.lang.perl.misc. If you're looking for help with using
321 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
325 # Prompt for subject of message, if needed
328 First of all, please provide a subject for the
329 message. It should be a concise description of
330 the bug or problem. "perl bug" or "perl problem"
331 is not a concise description.
337 while ($subject !~ /\S/) {
338 print "\nPlease enter a subject: ";
347 # Prompt for return address, if needed
349 # Try and guess return address
352 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
354 require Mac::InternetConfig;
355 $guess = $Mac::InternetConfig::InternetConfig{
356 Mac::InternetConfig::kICEmail()
363 $domain = Mail::Util::maildomain();
364 } elsif ($Is_MSWin32) {
365 $domain = $ENV{'USERDOMAIN'};
367 require Sys::Hostname;
368 $domain = Sys::Hostname::hostname();
371 if ($Is_VMS && !$::Config{'d_socket'}) {
372 $guess = "$domain\:\:$me";
374 $guess = "$me\@$domain" if $domain;
382 Your e-mail address will be useful if you need to be contacted. If the
383 default shown is not your full internet e-mail address, please correct it.
388 So that you may be contacted if necessary, please enter
389 your full internet e-mail address here.
398 print "Your address [$guess]: ";
401 $from = $guess if $from eq '';
405 if ($from eq $cc or $me eq $cc) {
406 # Try not to copy ourselves
410 # Prompt for administrator address, unless an override was given
411 if( !$::opt_C and !$::opt_c ) {
413 A copy of this report can be sent to your local
414 perl administrator. If the address is wrong, please
415 correct it, or enter 'none' or 'yourself' to not send
418 print "Local perl administrator [$cc]: ";
419 my $entry = scalar <>;
424 $cc = '' if $me eq $cc;
428 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
429 $andcc = " and $cc" if $cc;
431 # Prompt for editor, if no override is given
433 unless ($::opt_e || $::opt_f || $::opt_b) {
435 Now you need to supply the bug report. Try to make
436 the report concise but descriptive. Include any
437 relevant detail. If you are reporting something
438 that does not work as you think it should, please
439 try to include example of both the actual
440 result, and what you expected.
442 Some information about your local
443 perl configuration will automatically be included
444 at the end of the report. If you are using any
445 unusual version of perl, please try and confirm
446 exactly which versions are relevant.
448 You will probably want to use an editor to enter
449 the report. If "$ed" is the editor you want
450 to use, then just press Enter, otherwise type in
451 the name of the editor you would like to use.
453 If you would like to use a prepared file, type
454 "file", and you will be asked for the filename.
456 print "Editor [$ed]: ";
457 my $entry =scalar <>;
461 if ($entry eq "file") {
463 } elsif ($entry ne "") {
468 # Prompt for category of bug
469 $category ||= ask_for_alternatives("category", "core",
473 # Prompt for severity of bug
474 $severity ||= ask_for_alternatives("severity", "low",
475 qw(critical high medium
478 # Generate scratch file to edit report in
479 $filename = filename();
481 # Prompt for file to read report from, if needed
482 if ($usefile and !$file) {
485 What is the name of the file that contains your report?
488 my $entry = scalar <>;
493 No filename? I'll let you go back and choose an editor again.
498 unless (-f $entry and -r $entry) {
500 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
501 the file? If you don't want to send a file, just enter a blank line and you
502 can get back to the editor selection.
510 open(REP,">$filename");
511 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
514 This is a $reptype report for perl from $from,
515 generated with the help of perlbug $Version running under perl $perl_version.
523 or die "Unable to read report file from `$file': $!\n";
531 -----------------------------------------------------------------
532 [Please enter your report here]
536 [Please do not change anything below this line]
537 -----------------------------------------------------------------
543 # read in the report template once so that
544 # we can track whether the user does any editing.
545 # yes, *all* whitespace is ignored.
546 open(REP, "<$filename");
564 print OUT "This perlbug was built using Perl $config_tag1\n",
565 "It is being executed now by Perl $config_tag2.\n\n"
566 if $config_tag2 ne $config_tag1;
569 Site configuration information for perl $perl_version:
572 if ($::Config{cf_by} and $::Config{cf_time}) {
573 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
575 print OUT Config::myconfig;
578 print OUT join "\n ", "Locally applied patches:", @patches;
585 \@INC for perl $perl_version:
594 Environment for perl $perl_version:
597 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
598 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
599 push @env, grep /^(?:PERL|LC_|LANG)/, keys %ENV;
602 for my $env (sort keys %env) {
604 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
608 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
610 foreach (sort keys %::Config) {
611 $value = $::Config{$_};
613 print OUT "$_='$value'\n";
620 if ($usefile || $body) {
622 Please make sure that the name of the editor you want to use is correct.
624 print "Editor [$ed]: ";
625 my $entry =scalar <>;
627 $ed = $entry unless $entry eq '';
631 my $sts = system("$ed $filename") unless $Is_MacOS;
633 require ExtUtils::MakeMaker;
634 ExtUtils::MM_MacOS::launch_file($filename);
636 Press Enter when done.
642 The editor you chose (`$ed') could apparently not be run!
643 Did you mistype the name of your editor? If so, please
644 correct it here, otherwise just press Enter.
646 print "Editor [$ed]: ";
647 my $entry =scalar <>;
655 You may want to save your report to a file, so you can edit and mail it
661 return if ($ok and not $::opt_n) || $body;
662 # Check that we have a report that has some, eh, report in it.
665 open(REP, "<$filename");
666 # a strange way to check whether any significant editing
667 # have been done: check whether any new non-empty lines
668 # have been added. Yes, the below code ignores *any* space
672 $unseen++ if $_ ne '' and not exists $REP{$_};
675 while ($unseen == 0) {
677 I am sorry but it looks like you did not report anything.
679 print "Action (Retry Edit/Cancel) ";
680 my ($action) = scalar(<>);
681 if ($action =~ /^[re]/i) { # <R>etry <E>dit
683 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
690 1 while unlink($filename); # remove all versions under VMS
691 print "\nCancelling.\n";
696 # Report is done, prompt for further action
700 Now that you have completed your report, would you like to send
701 the message to $address$andcc, display the message on
702 the screen, re-edit it, or cancel without sending anything?
703 You may also save the message as a file to mail at another time.
706 print "Action (Send/Display/Edit/Cancel/Save to File): ";
707 my $action = scalar <>;
710 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
711 print "\n\nName of file to save message in [perlbug.rep]: ";
712 my $file = scalar <>;
714 $file = "perlbug.rep" if $file eq "";
716 unless (open(FILE, ">$file")) {
717 print "\nError opening $file: $!\n\n";
720 open(REP, "<$filename");
721 print FILE "To: $address\nSubject: $subject\n";
722 print FILE "Cc: $cc\n" if $cc;
723 print FILE "Reply-To: $from\n" if $from;
725 while (<REP>) { print FILE }
729 print "\nMessage saved in `$file'.\n";
731 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
732 # Display the message
733 open(REP, "<$filename");
734 while (<REP>) { print $_ }
736 } elsif ($action =~ /^se/i) { # <S>end
738 print "Are you certain you want to send this message?\n"
739 . 'Please type "yes" if you are: ';
740 my $reply = scalar <STDIN>;
742 if ($reply eq "yes") {
746 That wasn't a clear "yes", so I won't send your message. If you are sure
747 your message should be sent, type in "yes" (without the quotes) at the
751 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
754 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
756 } elsif ($action =~ /^s/) {
758 I'm sorry, but I didn't understand that. Please type "send" or "save".
766 # Message has been accepted for transmission -- Send the message
768 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
772 $msg = new Mail::Send Subject => $subject, To => $address;
773 $msg->cc($cc) if $cc;
774 $msg->add("Reply-To",$from) if $from;
777 open(REP, "<$filename");
778 while (<REP>) { print $fh $_ }
782 print "\nMessage sent.\n";
784 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
785 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
787 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
788 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
790 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
791 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
793 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
794 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
798 (leaving bug report in $filename): $sts
803 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
804 $sendmail = $_, last if -e $_;
806 if ($^O eq 'os2' and $sendmail eq "") {
807 my $path = $ENV{PATH};
809 my @path = split /$Config{'path_sep'}/, $path;
811 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
812 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
816 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
817 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
818 the perl package Mail::Send has not been installed, so I can't send your bug
819 report. We apologize for the inconvenience.
821 So you may attempt to find some way of sending your message, it has
822 been left in the file `$filename'.
824 open(SENDMAIL, "|$sendmail -t") || die "'|$sendmail -t' failed: $!";
826 print SENDMAIL "To: $address\n";
827 print SENDMAIL "Subject: $subject\n";
828 print SENDMAIL "Cc: $cc\n" if $cc;
829 print SENDMAIL "Reply-To: $from\n" if $from;
830 print SENDMAIL "\n\n";
831 open(REP, "<$filename");
832 while (<REP>) { print SENDMAIL $_ }
835 if (close(SENDMAIL)) {
836 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
838 warn "\nSendmail returned status '", $? >> 8, "'\n";
841 1 while unlink($filename); # remove all versions under VMS
847 A program to help generate bug reports about perl5, and mail them.
848 It is designed to be used interactively. Normally no arguments will
852 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
853 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
854 $0 [-v] [-r returnaddress] [-ok | -okay | -nok | -nokay]
856 Simplest usage: run "$0", and follow the prompts.
860 -v Include Verbose configuration data in the report
861 -f File containing the body of the report. Use this to
862 quickly send a prepared message.
863 -F File to output the resulting mail message to, instead of mailing.
864 -S Send without asking for confirmation.
865 -a Address to send the report to. Defaults to `$address'.
866 -c Address to send copy of report to. Defaults to `$cc'.
867 -C Don't send copy to administrator.
868 -s Subject to include with the message. You will be prompted
869 if you don't supply one on the command line.
870 -b Body of the report. If not included on the command line, or
871 in a file with -f, you will get a chance to edit the message.
872 -r Your return address. The program will ask you to confirm
873 this if you don't give it here.
875 -t Test mode. The target address defaults to `$testaddress'.
876 -d Data mode (the default if you redirect or pipe output.)
877 This prints out your configuration data, without mailing
878 anything. You can use this with -v to get more complete data.
879 -ok Report successful build on this system to perl porters
880 (use alone or with -v). Only use -ok if *everything* was ok:
881 if there were *any* problems at all, use -nok.
882 -okay As -ok but allow report from old builds.
883 -nok Report unsuccessful build on this system to perl porters
884 (use alone or with -v). You must describe what went wrong
885 in the body of the report which you will be asked to edit.
886 -nokay As -nok but allow report from old builds.
887 -h Print this help message.
893 my $dir = $Is_VMS ? 'sys$scratch:'
894 : ($Is_MSWin32 && $ENV{'TEMP'}) ? $ENV{'TEMP'}
895 : $Is_MacOS ? $ENV{'TMPDIR'}
897 $filename = "bugrep0$$";
898 # $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
899 $filename++ while -e File::Spec->catfile($dir, $filename);
900 $filename = File::Spec->catfile($dir, $filename);
904 my @paragraphs = split /\n{2,}/, "@_";
906 for (@paragraphs) { # implicit local $_
914 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
922 perlbug - how to submit bug reports on Perl
926 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
927 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
928 S<[ B<-r> I<returnaddress> ]>
929 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
930 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]>
932 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
933 S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
937 A program to help generate bug reports about perl or the modules that
938 come with it, and mail them.
940 If you have found a bug with a non-standard port (one that was not part
941 of the I<standard distribution>), a binary distribution, or a
942 non-standard module (such as Tk, CGI, etc), then please see the
943 documentation that came with that distribution to determine the correct
944 place to report bugs.
946 C<perlbug> is designed to be used interactively. Normally no arguments
947 will be needed. Simply run it, and follow the prompts.
949 If you are unable to run B<perlbug> (most likely because you don't have
950 a working setup to send mail that perlbug recognizes), you may have to
951 compose your own report, and email it to B<perlbug@perl.com>. You might
952 find the B<-d> option useful to get summary information in that case.
954 In any case, when reporting a bug, please make sure you have run through
959 =item What version of Perl you are running?
961 Type C<perl -v> at the command line to find out.
963 =item Are you running the latest released version of perl?
965 Look at http://www.perl.com/ to find out. If it is not the latest
966 released version, get that one and see whether your bug has been
967 fixed. Note that bug reports about old versions of Perl, especially
968 those prior to the 5.0 release, are likely to fall upon deaf ears.
969 You are on your own if you continue to use perl1 .. perl4.
971 =item Are you sure what you have is a bug?
973 A significant number of the bug reports we get turn out to be documented
974 features in Perl. Make sure the behavior you are witnessing doesn't fall
975 under that category, by glancing through the documentation that comes
976 with Perl (we'll admit this is no mean task, given the sheer volume of
977 it all, but at least have a look at the sections that I<seem> relevant).
979 Be aware of the familiar traps that perl programmers of various hues
980 fall into. See L<perltrap>.
982 Check in L<perldiag> to see what any Perl error message(s) mean.
983 If message isn't in perldiag, it probably isn't generated by Perl.
984 Consult your operating system documentation instead.
986 If you are on a non-UNIX platform check also L<perlport>, as some
987 features may be unimplemented or work differently.
989 Try to study the problem under the Perl debugger, if necessary.
992 =item Do you have a proper test case?
994 The easier it is to reproduce your bug, the more likely it will be
995 fixed, because if no one can duplicate the problem, no one can fix it.
996 A good test case has most of these attributes: fewest possible number
997 of lines; few dependencies on external commands, modules, or
998 libraries; runs on most platforms unimpeded; and is self-documenting.
1000 A good test case is almost always a good candidate to be on the perl
1001 test suite. If you have the time, consider making your test case so
1002 that it will readily fit into the standard test suite.
1004 Remember also to include the B<exact> error messages, if any.
1005 "Perl complained something" is not an exact error message.
1007 If you get a core dump (or equivalent), you may use a debugger
1008 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1009 report. NOTE: unless your Perl has been compiled with debug info
1010 (often B<-g>), the stack trace is likely to be somewhat hard to use
1011 because it will most probably contain only the function names and not
1012 their arguments. If possible, recompile your Perl with debug info and
1013 reproduce the dump and the stack trace.
1015 =item Can you describe the bug in plain English?
1017 The easier it is to understand a reproducible bug, the more likely it
1018 will be fixed. Anything you can provide by way of insight into the
1019 problem helps a great deal. In other words, try to analyze the
1020 problem (to the extent you can) and report your discoveries.
1022 =item Can you fix the bug yourself?
1024 A bug report which I<includes a patch to fix it> will almost
1025 definitely be fixed. Use the C<diff> program to generate your patches
1026 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1027 package, so you should be able to get it from any of the GNU software
1028 repositories). If you do submit a patch, the cool-dude counter at
1029 perlbug@perl.com will register you as a savior of the world. Your
1030 patch may be returned with requests for changes, or requests for more
1031 detailed explanations about your fix.
1033 Here are some clues for creating quality patches: Use the B<-c> or
1034 B<-u> switches to the diff program (to create a so-called context or
1035 unified diff). Make sure the patch is not reversed (the first
1036 argument to diff is typically the original file, the second argument
1037 your changed file). Make sure you test your patch by applying it with
1038 the C<patch> program before you send it on its way. Try to follow the
1039 same style as the code you are trying to patch. Make sure your patch
1040 really does work (C<make test>, if the thing you're patching supports
1043 =item Can you use C<perlbug> to submit the report?
1045 B<perlbug> will, amongst other things, ensure your report includes
1046 crucial information about your version of perl. If C<perlbug> is unable
1047 to mail your report after you have typed it in, you may have to compose
1048 the message yourself, add the output produced by C<perlbug -d> and email
1049 it to B<perlbug@perl.com>. If, for some reason, you cannot run
1050 C<perlbug> at all on your system, be sure to include the entire output
1051 produced by running C<perl -V> (note the uppercase V).
1053 Whether you use C<perlbug> or send the email manually, please make
1054 your Subject line informative. "a bug" not informative. Neither is
1055 "perl crashes" nor "HELP!!!". These don't help.
1056 A compact description of what's wrong is fine.
1060 Having done your bit, please be prepared to wait, to be told the bug
1061 is in your code, or even to get no reply at all. The Perl maintainers
1062 are busy folks, so if your problem is a small one or if it is difficult
1063 to understand or already known, they may not respond with a personal reply.
1064 If it is important to you that your bug be fixed, do monitor the
1065 C<Changes> file in any development releases since the time you submitted
1066 the bug, and encourage the maintainers with kind words (but never any
1067 flames!). Feel free to resend your bug report if the next released
1068 version of perl comes out and your bug is still present.
1076 Address to send the report to. Defaults to `perlbug@perl.com'.
1080 Body of the report. If not included on the command line, or
1081 in a file with B<-f>, you will get a chance to edit the message.
1085 Don't send copy to administrator.
1089 Address to send copy of report to. Defaults to the address of the
1090 local perl administrator (recorded when perl was built).
1094 Data mode (the default if you redirect or pipe output). This prints out
1095 your configuration data, without mailing anything. You can use this
1096 with B<-v> to get more complete data.
1104 File containing the body of the report. Use this to quickly send a
1109 File to output the results to instead of sending as an email. Useful
1110 particularly when running perlbug on a machine with no direct internet
1115 Prints a brief summary of the options.
1119 Report successful build on this system to perl porters. Forces B<-S>
1120 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1121 prompts for a return address if it cannot guess it (for use with
1122 B<make>). Honors return address specified with B<-r>. You can use this
1123 with B<-v> to get more complete data. Only makes a report if this
1124 system is less than 60 days old.
1128 As B<-ok> except it will report on older systems.
1132 Report unsuccessful build on this system. Forces B<-C>. Forces and
1133 supplies a value for B<-s>, then requires you to edit the report
1134 and say what went wrong. Alternatively, a prepared report may be
1135 supplied using B<-f>. Only prompts for a return address if it
1136 cannot guess it (for use with B<make>). Honors return address
1137 specified with B<-r>. You can use this with B<-v> to get more
1138 complete data. Only makes a report if this system is less than 60
1143 As B<-nok> except it will report on older systems.
1147 Your return address. The program will ask you to confirm its default
1148 if you don't use this option.
1152 Send without asking for confirmation.
1156 Subject to include with the message. You will be prompted if you don't
1157 supply one on the command line.
1161 Test mode. The target address defaults to `perlbug-test@perl.com'.
1165 Include verbose configuration data in the report.
1171 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1172 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1173 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1174 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1175 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1176 Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>),
1177 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1178 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1179 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1183 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1184 diff(1), patch(1), dbx(1), gdb(1)
1188 None known (guess what must have been used to report them?)
1194 close OUT or die "Can't close $file: $!";
1195 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1196 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';