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%v", $^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
127 # TODO: - Allow the user to re-name the file on mail failure, and
128 # make sure failure (transmission-wise) of Mail::Send is
132 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
133 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS,
134 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
136 my $perl_version = $^V ? sprintf("v%v", $^V) : $];
138 my $config_tag2 = "$perl_version - $Config{cf_time}";
142 if ($::opt_h) { Help(); exit; }
143 if ($::opt_d) { Dump(*STDOUT); exit; }
144 if (!-t STDIN && !($ok and not $::opt_n)) {
146 Please use perlbug interactively. If you want to
147 include a file, you can use the -f switch.
151 if (!-t STDOUT && !$outfile) { Dump(*STDOUT); exit; }
154 Edit() unless $usefile || ($ok and not $::opt_n);
161 # -------- Setup --------
163 $Is_MSWin32 = $^O eq 'MSWin32';
164 $Is_VMS = $^O eq 'VMS';
165 $Is_MacOS = $^O eq 'MacOS';
167 @ARGV = split m/\s+/,
168 MacPerl::Ask('Provide command-line args here (-h for help):')
169 if $Is_MacOS && $MacPerl::Version =~ /App/;
171 if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
173 # This comment is needed to notify metaconfig that we are
174 # using the $perladmin, $cf_by, and $cf_time definitions.
176 # -------- Configuration ---------
179 $perlbug = 'perlbug@perl.com';
182 $testaddress = 'perlbug-test@perl.com';
185 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
187 # Users address, used in message and in Reply-To header
188 $from = $::opt_r || "";
190 # Include verbose configuration information
191 $verbose = $::opt_v || 0;
193 # Subject of bug-report message
194 $subject = $::opt_s || "";
197 $usefile = ($::opt_f || 0);
199 # File to send as report
200 $file = $::opt_f || "";
203 $outfile = $::opt_F || "";
206 $body = $::opt_b || "";
209 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
210 || ($Is_VMS && "edit/tpu")
211 || ($Is_MSWin32 && "notepad")
215 # Not OK - provide build failure template by finessing OK report
217 if (substr($::opt_n, 0, 2) eq 'ok' ) {
218 $::opt_o = substr($::opt_n, 1);
225 # OK - send "OK" report for build on this system
228 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
229 my $age = time - $patchlevel_date;
230 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
231 my $date = localtime $patchlevel_date;
233 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
234 are more than 60 days old. This Perl version was constructed on
235 $date. If you really want to report this, use
236 "perlbug -okay" or "perlbug -nokay".
240 # force these options
242 $::opt_S = 1; # don't prompt for send
243 $::opt_b = 1; # we have a body
244 $body = "Perl reported to build OK on this system.\n";
246 $::opt_C = 1; # don't send a copy to the local admin
247 $::opt_s = 1; # we have a subject line
248 $subject = ($::opt_n ? 'Not ' : '')
249 . "OK: perl $perl_version ${patch_tags}on"
250 ." $::Config{'archname'} $::Config{'osvers'} $subject";
258 # Possible administrator addresses, in order of confidence
259 # (Note that cf_email is not mentioned to metaconfig, since
260 # we don't really want it. We'll just take it if we have to.)
262 # This has to be after the $ok stuff above because of the way
263 # that $::opt_C is forced.
264 $cc = $::opt_C ? "" : (
265 $::opt_c || $::Config{'perladmin'}
266 || $::Config{'cf_email'} || $::Config{'cf_by'}
270 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
271 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
272 : $Is_MacOS ? $ENV{'USER'}
273 : eval { getpwuid($<) }; # May be missing
275 $from = $::Config{'cf_email'}
276 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
277 ($me eq $::Config{'cf_by'});
281 # Explain what perlbug is
284 This program provides an easy way to create a message reporting a bug
285 in perl, and e-mail it to $address. It is *NOT* intended for
286 sending test messages or simply verifying that perl works, *NOR* is it
287 intended for reporting bugs in third-party perl modules. It is *ONLY*
288 a means of reporting verifiable problems with the core perl distribution,
289 and any solutions to such problems, to the people who maintain perl.
291 If you're just looking for help with perl, try posting to the Usenet
292 newsgroup comp.lang.perl.misc. If you're looking for help with using
293 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
297 # Prompt for subject of message, if needed
300 First of all, please provide a subject for the
301 message. It should be a concise description of
302 the bug or problem. "perl bug" or "perl problem"
303 is not a concise description.
309 while ($subject !~ /\S/) {
310 print "\nPlease enter a subject: ";
319 # Prompt for return address, if needed
321 # Try and guess return address
324 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
326 require Mac::InternetConfig;
327 $guess = $Mac::InternetConfig::InternetConfig{
328 Mac::InternetConfig::kICEmail()
335 $domain = Mail::Util::maildomain();
336 } elsif ($Is_MSWin32) {
337 $domain = $ENV{'USERDOMAIN'};
339 require Sys::Hostname;
340 $domain = Sys::Hostname::hostname();
343 if ($Is_VMS && !$::Config{'d_socket'}) {
344 $guess = "$domain\:\:$me";
346 $guess = "$me\@$domain" if $domain;
354 Your e-mail address will be useful if you need to be contacted. If the
355 default shown is not your full internet e-mail address, please correct it.
360 So that you may be contacted if necessary, please enter
361 your full internet e-mail address here.
370 print "Your address [$guess]: ";
373 $from = $guess if $from eq '';
377 if ($from eq $cc or $me eq $cc) {
378 # Try not to copy ourselves
382 # Prompt for administrator address, unless an override was given
383 if( !$::opt_C and !$::opt_c ) {
385 A copy of this report can be sent to your local
386 perl administrator. If the address is wrong, please
387 correct it, or enter 'none' or 'yourself' to not send
390 print "Local perl administrator [$cc]: ";
391 my $entry = scalar <>;
396 $cc = '' if $me eq $cc;
400 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
401 $andcc = " and $cc" if $cc;
403 # Prompt for editor, if no override is given
405 unless ($::opt_e || $::opt_f || $::opt_b) {
407 Now you need to supply the bug report. Try to make
408 the report concise but descriptive. Include any
409 relevant detail. If you are reporting something
410 that does not work as you think it should, please
411 try to include example of both the actual
412 result, and what you expected.
414 Some information about your local
415 perl configuration will automatically be included
416 at the end of the report. If you are using any
417 unusual version of perl, please try and confirm
418 exactly which versions are relevant.
420 You will probably want to use an editor to enter
421 the report. If "$ed" is the editor you want
422 to use, then just press Enter, otherwise type in
423 the name of the editor you would like to use.
425 If you would like to use a prepared file, type
426 "file", and you will be asked for the filename.
428 print "Editor [$ed]: ";
429 my $entry =scalar <>;
433 if ($entry eq "file") {
435 } elsif ($entry ne "") {
440 # Generate scratch file to edit report in
441 $filename = filename();
443 # Prompt for file to read report from, if needed
444 if ($usefile and !$file) {
447 What is the name of the file that contains your report?
450 my $entry = scalar <>;
455 No filename? I'll let you go back and choose an editor again.
460 unless (-f $entry and -r $entry) {
462 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
463 the file? If you don't want to send a file, just enter a blank line and you
464 can get back to the editor selection.
472 open(REP,">$filename");
473 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
476 This is a $reptype report for perl from $from,
477 generated with the help of perlbug $Version running under perl $perl_version.
485 or die "Unable to read report file from `$file': $!\n";
493 -----------------------------------------------------------------
494 [Please enter your report here]
498 [Please do not change anything below this line]
499 -----------------------------------------------------------------
505 # read in the report template once so that
506 # we can track whether the user does any editing.
507 # yes, *all* whitespace is ignored.
508 open(REP, "<$filename");
520 print REP "This perlbug was built using Perl $config_tag1\n",
521 "It is being executed now by Perl $config_tag2.\n\n"
522 if $config_tag2 ne $config_tag1;
525 Site configuration information for perl $perl_version:
528 if ($::Config{cf_by} and $::Config{cf_time}) {
529 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
531 print OUT Config::myconfig;
534 print OUT join "\n ", "Locally applied patches:", @patches;
541 \@INC for perl $perl_version:
550 Environment for perl $perl_version:
553 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
554 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
555 push @env, grep /^(?:PERL|LC_|LANG)/, keys %ENV;
558 for my $env (sort keys %env) {
560 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
564 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
566 foreach (sort keys %::Config) {
567 $value = $::Config{$_};
569 print OUT "$_='$value'\n";
576 if ($usefile || $body) {
578 Please make sure that the name of the editor you want to use is correct.
580 print "Editor [$ed]: ";
581 my $entry =scalar <>;
583 $ed = $entry unless $entry eq '';
587 my $sts = system("$ed $filename") unless $Is_MacOS;
589 require ExtUtils::MakeMaker;
590 ExtUtils::MM_MacOS::launch_file($filename);
592 Press Enter when done.
598 The editor you chose (`$ed') could apparently not be run!
599 Did you mistype the name of your editor? If so, please
600 correct it here, otherwise just press Enter.
602 print "Editor [$ed]: ";
603 my $entry =scalar <>;
611 You may want to save your report to a file, so you can edit and mail it
617 return if ($ok and not $::opt_n) || $body;
618 # Check that we have a report that has some, eh, report in it.
621 open(REP, "<$filename");
622 # a strange way to check whether any significant editing
623 # have been done: check whether any new non-empty lines
624 # have been added. Yes, the below code ignores *any* space
628 $unseen++ if $_ ne '' and not exists $REP{$_};
631 while ($unseen == 0) {
633 I am sorry but it looks like you did not report anything.
635 print "Action (Retry Edit/Cancel) ";
636 my ($action) = scalar(<>);
637 if ($action =~ /^[re]/i) { # <R>etry <E>dit
639 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
646 1 while unlink($filename); # remove all versions under VMS
647 print "\nCancelling.\n";
652 # Report is done, prompt for further action
656 Now that you have completed your report, would you like to send
657 the message to $address$andcc, display the message on
658 the screen, re-edit it, or cancel without sending anything?
659 You may also save the message as a file to mail at another time.
662 print "Action (Send/Display/Edit/Cancel/Save to File): ";
663 my $action = scalar <>;
666 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
667 print "\n\nName of file to save message in [perlbug.rep]: ";
668 my $file = scalar <>;
670 $file = "perlbug.rep" if $file eq "";
672 unless (open(FILE, ">$file")) {
673 print "\nError opening $file: $!\n\n";
676 open(REP, "<$filename");
677 print FILE "To: $address\nSubject: $subject\n";
678 print FILE "Cc: $cc\n" if $cc;
679 print FILE "Reply-To: $from\n" if $from;
681 while (<REP>) { print FILE }
685 print "\nMessage saved in `$file'.\n";
687 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
688 # Display the message
689 open(REP, "<$filename");
690 while (<REP>) { print $_ }
692 } elsif ($action =~ /^se/i) { # <S>end
694 print "Are you certain you want to send this message?\n"
695 . 'Please type "yes" if you are: ';
696 my $reply = scalar <STDIN>;
698 if ($reply eq "yes") {
702 That wasn't a clear "yes", so I won't send your message. If you are sure
703 your message should be sent, type in "yes" (without the quotes) at the
707 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
710 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
712 } elsif ($action =~ /^s/) {
714 I'm sorry, but I didn't understand that. Please type "send" or "save".
722 # Message has been accepted for transmission -- Send the message
724 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
728 $msg = new Mail::Send Subject => $subject, To => $address;
729 $msg->cc($cc) if $cc;
730 $msg->add("Reply-To",$from) if $from;
733 open(REP, "<$filename");
734 while (<REP>) { print $fh $_ }
738 print "\nMessage sent.\n";
740 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
741 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
743 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
744 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
746 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
747 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
749 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
750 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
754 (leaving bug report in $filename): $sts
759 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
760 $sendmail = $_, last if -e $_;
762 if ($^O eq 'os2' and $sendmail eq "") {
763 my $path = $ENV{PATH};
765 my @path = split /$Config{'path_sep'}/, $path;
767 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
768 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
772 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
773 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
774 the perl package Mail::Send has not been installed, so I can't send your bug
775 report. We apologize for the inconvenience.
777 So you may attempt to find some way of sending your message, it has
778 been left in the file `$filename'.
780 open(SENDMAIL, "|$sendmail -t") || die "'|$sendmail -t' failed: $!";
782 print SENDMAIL "To: $address\n";
783 print SENDMAIL "Subject: $subject\n";
784 print SENDMAIL "Cc: $cc\n" if $cc;
785 print SENDMAIL "Reply-To: $from\n" if $from;
786 print SENDMAIL "\n\n";
787 open(REP, "<$filename");
788 while (<REP>) { print SENDMAIL $_ }
791 if (close(SENDMAIL)) {
792 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
794 warn "\nSendmail returned status '", $? >> 8, "'\n";
797 1 while unlink($filename); # remove all versions under VMS
803 A program to help generate bug reports about perl5, and mail them.
804 It is designed to be used interactively. Normally no arguments will
808 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
809 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
810 $0 [-v] [-r returnaddress] [-ok | -okay | -nok | -nokay]
812 Simplest usage: run "$0", and follow the prompts.
816 -v Include Verbose configuration data in the report
817 -f File containing the body of the report. Use this to
818 quickly send a prepared message.
819 -F File to output the resulting mail message to, instead of mailing.
820 -S Send without asking for confirmation.
821 -a Address to send the report to. Defaults to `$address'.
822 -c Address to send copy of report to. Defaults to `$cc'.
823 -C Don't send copy to administrator.
824 -s Subject to include with the message. You will be prompted
825 if you don't supply one on the command line.
826 -b Body of the report. If not included on the command line, or
827 in a file with -f, you will get a chance to edit the message.
828 -r Your return address. The program will ask you to confirm
829 this if you don't give it here.
831 -t Test mode. The target address defaults to `$testaddress'.
832 -d Data mode (the default if you redirect or pipe output.)
833 This prints out your configuration data, without mailing
834 anything. You can use this with -v to get more complete data.
835 -ok Report successful build on this system to perl porters
836 (use alone or with -v). Only use -ok if *everything* was ok:
837 if there were *any* problems at all, use -nok.
838 -okay As -ok but allow report from old builds.
839 -nok Report unsuccessful build on this system to perl porters
840 (use alone or with -v). You must describe what went wrong
841 in the body of the report which you will be asked to edit.
842 -nokay As -nok but allow report from old builds.
843 -h Print this help message.
849 my $dir = $Is_VMS ? 'sys$scratch:'
850 : ($Is_MSWin32 && $ENV{'TEMP'}) ? $ENV{'TEMP'}
851 : $Is_MacOS ? $ENV{'TMPDIR'}
853 $filename = "bugrep0$$";
854 # $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
855 $filename++ while -e File::Spec->catfile($dir, $filename);
856 $filename = File::Spec->catfile($dir, $filename);
860 my @paragraphs = split /\n{2,}/, "@_";
862 for (@paragraphs) { # implicit local $_
870 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
878 perlbug - how to submit bug reports on Perl
882 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
883 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
884 S<[ B<-r> I<returnaddress> ]>
885 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
886 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]>
888 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
889 S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
893 A program to help generate bug reports about perl or the modules that
894 come with it, and mail them.
896 If you have found a bug with a non-standard port (one that was not part
897 of the I<standard distribution>), a binary distribution, or a
898 non-standard module (such as Tk, CGI, etc), then please see the
899 documentation that came with that distribution to determine the correct
900 place to report bugs.
902 C<perlbug> is designed to be used interactively. Normally no arguments
903 will be needed. Simply run it, and follow the prompts.
905 If you are unable to run B<perlbug> (most likely because you don't have
906 a working setup to send mail that perlbug recognizes), you may have to
907 compose your own report, and email it to B<perlbug@perl.com>. You might
908 find the B<-d> option useful to get summary information in that case.
910 In any case, when reporting a bug, please make sure you have run through
915 =item What version of Perl you are running?
917 Type C<perl -v> at the command line to find out.
919 =item Are you running the latest released version of perl?
921 Look at http://www.perl.com/ to find out. If it is not the latest
922 released version, get that one and see whether your bug has been
923 fixed. Note that bug reports about old versions of Perl, especially
924 those prior to the 5.0 release, are likely to fall upon deaf ears.
925 You are on your own if you continue to use perl1 .. perl4.
927 =item Are you sure what you have is a bug?
929 A significant number of the bug reports we get turn out to be documented
930 features in Perl. Make sure the behavior you are witnessing doesn't fall
931 under that category, by glancing through the documentation that comes
932 with Perl (we'll admit this is no mean task, given the sheer volume of
933 it all, but at least have a look at the sections that I<seem> relevant).
935 Be aware of the familiar traps that perl programmers of various hues
936 fall into. See L<perltrap>.
938 Check in L<perldiag> to see what any Perl error message(s) mean.
939 If message isn't in perldiag, it probably isn't generated by Perl.
940 Consult your operating system documentation instead.
942 If you are on a non-UNIX platform check also L<perlport>, as some
943 features may be unimplemented or work differently.
945 Try to study the problem under the Perl debugger, if necessary.
948 =item Do you have a proper test case?
950 The easier it is to reproduce your bug, the more likely it will be
951 fixed, because if no one can duplicate the problem, no one can fix it.
952 A good test case has most of these attributes: fewest possible number
953 of lines; few dependencies on external commands, modules, or
954 libraries; runs on most platforms unimpeded; and is self-documenting.
956 A good test case is almost always a good candidate to be on the perl
957 test suite. If you have the time, consider making your test case so
958 that it will readily fit into the standard test suite.
960 Remember also to include the B<exact> error messages, if any.
961 "Perl complained something" is not an exact error message.
963 If you get a core dump (or equivalent), you may use a debugger
964 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
965 report. NOTE: unless your Perl has been compiled with debug info
966 (often B<-g>), the stack trace is likely to be somewhat hard to use
967 because it will most probably contain only the function names and not
968 their arguments. If possible, recompile your Perl with debug info and
969 reproduce the dump and the stack trace.
971 =item Can you describe the bug in plain English?
973 The easier it is to understand a reproducible bug, the more likely it
974 will be fixed. Anything you can provide by way of insight into the
975 problem helps a great deal. In other words, try to analyze the
976 problem (to the extent you can) and report your discoveries.
978 =item Can you fix the bug yourself?
980 A bug report which I<includes a patch to fix it> will almost
981 definitely be fixed. Use the C<diff> program to generate your patches
982 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
983 package, so you should be able to get it from any of the GNU software
984 repositories). If you do submit a patch, the cool-dude counter at
985 perlbug@perl.com will register you as a savior of the world. Your
986 patch may be returned with requests for changes, or requests for more
987 detailed explanations about your fix.
989 Here are some clues for creating quality patches: Use the B<-c> or
990 B<-u> switches to the diff program (to create a so-called context or
991 unified diff). Make sure the patch is not reversed (the first
992 argument to diff is typically the original file, the second argument
993 your changed file). Make sure you test your patch by applying it with
994 the C<patch> program before you send it on its way. Try to follow the
995 same style as the code you are trying to patch. Make sure your patch
996 really does work (C<make test>, if the thing you're patching supports
999 =item Can you use C<perlbug> to submit the report?
1001 B<perlbug> will, amongst other things, ensure your report includes
1002 crucial information about your version of perl. If C<perlbug> is unable
1003 to mail your report after you have typed it in, you may have to compose
1004 the message yourself, add the output produced by C<perlbug -d> and email
1005 it to B<perlbug@perl.com>. If, for some reason, you cannot run
1006 C<perlbug> at all on your system, be sure to include the entire output
1007 produced by running C<perl -V> (note the uppercase V).
1009 Whether you use C<perlbug> or send the email manually, please make
1010 your Subject line informative. "a bug" not informative. Neither is
1011 "perl crashes" nor "HELP!!!". These don't help.
1012 A compact description of what's wrong is fine.
1016 Having done your bit, please be prepared to wait, to be told the bug
1017 is in your code, or even to get no reply at all. The Perl maintainers
1018 are busy folks, so if your problem is a small one or if it is difficult
1019 to understand or already known, they may not respond with a personal reply.
1020 If it is important to you that your bug be fixed, do monitor the
1021 C<Changes> file in any development releases since the time you submitted
1022 the bug, and encourage the maintainers with kind words (but never any
1023 flames!). Feel free to resend your bug report if the next released
1024 version of perl comes out and your bug is still present.
1032 Address to send the report to. Defaults to `perlbug@perl.com'.
1036 Body of the report. If not included on the command line, or
1037 in a file with B<-f>, you will get a chance to edit the message.
1041 Don't send copy to administrator.
1045 Address to send copy of report to. Defaults to the address of the
1046 local perl administrator (recorded when perl was built).
1050 Data mode (the default if you redirect or pipe output). This prints out
1051 your configuration data, without mailing anything. You can use this
1052 with B<-v> to get more complete data.
1060 File containing the body of the report. Use this to quickly send a
1065 File to output the results to instead of sending as an email. Useful
1066 particularly when running perlbug on a machine with no direct internet
1071 Prints a brief summary of the options.
1075 Report successful build on this system to perl porters. Forces B<-S>
1076 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1077 prompts for a return address if it cannot guess it (for use with
1078 B<make>). Honors return address specified with B<-r>. You can use this
1079 with B<-v> to get more complete data. Only makes a report if this
1080 system is less than 60 days old.
1084 As B<-ok> except it will report on older systems.
1088 Report unsuccessful build on this system. Forces B<-C>. Forces and
1089 supplies a value for B<-s>, then requires you to edit the report
1090 and say what went wrong. Alternatively, a prepared report may be
1091 supplied using B<-f>. Only prompts for a return address if it
1092 cannot guess it (for use with B<make>). Honors return address
1093 specified with B<-r>. You can use this with B<-v> to get more
1094 complete data. Only makes a report if this system is less than 60
1099 As B<-nok> except it will report on older systems.
1103 Your return address. The program will ask you to confirm its default
1104 if you don't use this option.
1108 Send without asking for confirmation.
1112 Subject to include with the message. You will be prompted if you don't
1113 supply one on the command line.
1117 Test mode. The target address defaults to `perlbug-test@perl.com'.
1121 Include verbose configuration data in the report.
1127 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1128 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1129 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1130 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1131 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1132 Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>),
1133 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), hris Nandor
1134 (E<lt>pudge@pobox.comE<gt>), and Jon Orwant (E<lt>orwant@media.mit.eduE<gt>).
1138 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1139 diff(1), patch(1), dbx(1), gdb(1)
1143 None known (guess what must have been used to report them?)
1149 close OUT or die "Can't close $file: $!";
1150 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1151 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';