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 print OUT <<"!GROK!THIS!";
62 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
63 if \$running_under_some_shell;
65 my \$config_tag1 = '$] - $Config{cf_time}';
67 my \$patchlevel_date = $patchlevel_date;
68 my \$patch_tags = '$patch_tags';
74 # In the following, perl variables are not expanded during extraction.
76 print OUT <<'!NO!SUBS!';
79 use File::Spec::Functions;
86 eval "use Mail::Send;";
87 $::HaveSend = ($@ eq "");
88 eval "use Mail::Util;";
89 $::HaveUtil = ($@ eq "");
94 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
95 # Changed in 1.07 to see more sendmail execs, and added pipe output.
96 # Changed in 1.08 to use correct address for sendmail.
97 # Changed in 1.09 to close the REP file before calling it up in the editor.
98 # Also removed some old comments duplicated elsewhere.
99 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
100 # temp filename generation.
101 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
102 # Changed in 1.12 to check for editor errors, make save/send distinction
103 # clearer and add $ENV{REPLYTO}.
104 # Changed in 1.13 to hopefully make it more difficult to accidentally
106 # Changed in 1.14 to make the prompts a little more clear on providing
107 # helpful information. Also let file read fail gracefully.
108 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
109 # Also report selected environment variables.
110 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
111 # Changed in 1.17 Win32 support added. GSAR 97-04-12
112 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
113 # Changed in 1.19 '-ok' default not '-v'
114 # add local patch information
115 # warn on '-ok' if this is an old system; add '-okay'
116 # Changed in 1.20 Added patchlevel.h reading and version/config checks
117 # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
118 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
119 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
120 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
121 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
122 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
123 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
125 # TODO: - Allow the user to re-name the file on mail failure, and
126 # make sure failure (transmission-wise) of Mail::Send is
130 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
131 $subject, $from, $verbose, $ed, $outfile, $Is_MacOS,
132 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
134 my $config_tag2 = "$] - $Config{cf_time}";
138 if ($::opt_h) { Help(); exit; }
139 if ($::opt_d) { Dump(*STDOUT); exit; }
140 if (!-t STDIN && !($ok and not $::opt_n)) {
142 Please use perlbug interactively. If you want to
143 include a file, you can use the -f switch.
147 if (!-t STDOUT && !$outfile) { Dump(*STDOUT); exit; }
150 Edit() unless $usefile || ($ok and not $::opt_n);
157 # -------- Setup --------
159 $Is_MSWin32 = $^O eq 'MSWin32';
160 $Is_VMS = $^O eq 'VMS';
161 $Is_MacOS = $^O eq 'MacOS';
163 @ARGV = split m/\s+/,
164 MacPerl::Ask('Provide command-line args here (-h for help):')
165 if $Is_MacOS && $MacPerl::Version =~ /App/;
167 if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; };
169 # This comment is needed to notify metaconfig that we are
170 # using the $perladmin, $cf_by, and $cf_time definitions.
172 # -------- Configuration ---------
175 $perlbug = 'perlbug@perl.com';
178 $testaddress = 'perlbug-test@perl.com';
181 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
183 # Users address, used in message and in Reply-To header
184 $from = $::opt_r || "";
186 # Include verbose configuration information
187 $verbose = $::opt_v || 0;
189 # Subject of bug-report message
190 $subject = $::opt_s || "";
193 $usefile = ($::opt_f || 0);
195 # File to send as report
196 $file = $::opt_f || "";
199 $outfile = $::opt_F || "";
202 $body = $::opt_b || "";
205 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
206 || ($Is_VMS && "edit/tpu")
207 || ($Is_MSWin32 && "notepad")
211 # Not OK - provide build failure template by finessing OK report
213 if (substr($::opt_n, 0, 2) eq 'ok' ) {
214 $::opt_o = substr($::opt_n, 1);
221 # OK - send "OK" report for build on this system
224 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
225 my $age = time - $patchlevel_date;
226 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
227 my $date = localtime $patchlevel_date;
229 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
230 are more than 60 days old. This Perl version was constructed on
231 $date. If you really want to report this, use
232 "perlbug -okay" or "perlbug -nokay".
236 # force these options
238 $::opt_S = 1; # don't prompt for send
239 $::opt_b = 1; # we have a body
240 $body = "Perl reported to build OK on this system.\n";
242 $::opt_C = 1; # don't send a copy to the local admin
243 $::opt_s = 1; # we have a subject line
244 $subject = ($::opt_n ? 'Not ' : '')
245 . "OK: perl $] ${patch_tags}on"
246 ." $::Config{'archname'} $::Config{'osvers'} $subject";
254 # Possible administrator addresses, in order of confidence
255 # (Note that cf_email is not mentioned to metaconfig, since
256 # we don't really want it. We'll just take it if we have to.)
258 # This has to be after the $ok stuff above because of the way
259 # that $::opt_C is forced.
260 $cc = $::opt_C ? "" : (
261 $::opt_c || $::Config{'perladmin'}
262 || $::Config{'cf_email'} || $::Config{'cf_by'}
266 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
267 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
268 : $Is_MacOS ? $ENV{'USER'}
269 : eval { getpwuid($<) }; # May be missing
271 $from = $::Config{'cf_email'}
272 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
273 ($me eq $::Config{'cf_by'});
277 # Explain what perlbug is
280 This program provides an easy way to create a message reporting a bug
281 in perl, and e-mail it to $address. It is *NOT* intended for
282 sending test messages or simply verifying that perl works, *NOR* is it
283 intended for reporting bugs in third-party perl modules. It is *ONLY*
284 a means of reporting verifiable problems with the core perl distribution,
285 and any solutions to such problems, to the people who maintain perl.
287 If you're just looking for help with perl, try posting to the Usenet
288 newsgroup comp.lang.perl.misc. If you're looking for help with using
289 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
293 # Prompt for subject of message, if needed
296 First of all, please provide a subject for the
297 message. It should be a concise description of
298 the bug or problem. "perl bug" or "perl problem"
299 is not a concise description.
305 while ($subject !~ /\S/) {
306 print "\nPlease enter a subject: ";
315 # Prompt for return address, if needed
317 # Try and guess return address
320 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
322 require Mac::InternetConfig;
323 $guess = $Mac::InternetConfig::InternetConfig{
324 Mac::InternetConfig::kICEmail()
331 $domain = Mail::Util::maildomain();
332 } elsif ($Is_MSWin32) {
333 $domain = $ENV{'USERDOMAIN'};
335 require Sys::Hostname;
336 $domain = Sys::Hostname::hostname();
339 if ($Is_VMS && !$::Config{'d_socket'}) {
340 $guess = "$domain\:\:$me";
342 $guess = "$me\@$domain" if $domain;
350 Your e-mail address will be useful if you need to be contacted. If the
351 default shown is not your full internet e-mail address, please correct it.
356 So that you may be contacted if necessary, please enter
357 your full internet e-mail address here.
366 print "Your address [$guess]: ";
369 $from = $guess if $from eq '';
373 if ($from eq $cc or $me eq $cc) {
374 # Try not to copy ourselves
378 # Prompt for administrator address, unless an override was given
379 if( !$::opt_C and !$::opt_c ) {
381 A copy of this report can be sent to your local
382 perl administrator. If the address is wrong, please
383 correct it, or enter 'none' or 'yourself' to not send
386 print "Local perl administrator [$cc]: ";
387 my $entry = scalar <>;
392 $cc = '' if $me eq $cc;
396 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
397 $andcc = " and $cc" if $cc;
399 # Prompt for editor, if no override is given
401 unless ($::opt_e || $::opt_f || $::opt_b) {
403 Now you need to supply the bug report. Try to make
404 the report concise but descriptive. Include any
405 relevant detail. If you are reporting something
406 that does not work as you think it should, please
407 try to include example of both the actual
408 result, and what you expected.
410 Some information about your local
411 perl configuration will automatically be included
412 at the end of the report. If you are using any
413 unusual version of perl, please try and confirm
414 exactly which versions are relevant.
416 You will probably want to use an editor to enter
417 the report. If "$ed" is the editor you want
418 to use, then just press Enter, otherwise type in
419 the name of the editor you would like to use.
421 If you would like to use a prepared file, type
422 "file", and you will be asked for the filename.
424 print "Editor [$ed]: ";
425 my $entry =scalar <>;
429 if ($entry eq "file") {
431 } elsif ($entry ne "") {
436 # Generate scratch file to edit report in
437 $filename = filename();
439 # Prompt for file to read report from, if needed
440 if ($usefile and !$file) {
443 What is the name of the file that contains your report?
446 my $entry = scalar <>;
451 No filename? I'll let you go back and choose an editor again.
456 unless (-f $entry and -r $entry) {
458 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
459 the file? If you don't want to send a file, just enter a blank line and you
460 can get back to the editor selection.
468 open(REP,">$filename");
469 my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success";
472 This is a $reptype report for perl from $from,
473 generated with the help of perlbug $Version running under perl $].
481 or die "Unable to read report file from `$file': $!\n";
489 -----------------------------------------------------------------
490 [Please enter your report here]
494 [Please do not change anything below this line]
495 -----------------------------------------------------------------
501 # read in the report template once so that
502 # we can track whether the user does any editing.
503 # yes, *all* whitespace is ignored.
504 open(REP, "<$filename");
516 print REP "This perlbug was built using Perl $config_tag2\n",
517 "It is being executed now by Perl $config_tag1.\n\n"
518 if $config_tag2 ne $config_tag1;
521 Site configuration information for perl $]:
524 if ($::Config{cf_by} and $::Config{cf_time}) {
525 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
527 print OUT Config::myconfig;
530 print OUT join "\n ", "Locally applied patches:", @patches;
546 Environment for perl $]:
549 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
550 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
551 push @env, grep /^(?:PERL|LC_|LANG)/, keys %ENV;
554 for my $env (sort keys %env) {
556 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
560 print OUT "\nComplete configuration data for perl $]:\n\n";
562 foreach (sort keys %::Config) {
563 $value = $::Config{$_};
565 print OUT "$_='$value'\n";
572 if ($usefile || $body) {
574 Please make sure that the name of the editor you want to use is correct.
576 print "Editor [$ed]: ";
577 my $entry =scalar <>;
579 $ed = $entry unless $entry eq '';
583 my $sts = system("$ed $filename") unless $Is_MacOS;
585 require ExtUtils::MakeMaker;
586 ExtUtils::MM_MacOS::launch_file($filename);
588 Press Enter when done.
594 The editor you chose (`$ed') could apparently not be run!
595 Did you mistype the name of your editor? If so, please
596 correct it here, otherwise just press Enter.
598 print "Editor [$ed]: ";
599 my $entry =scalar <>;
607 You may want to save your report to a file, so you can edit and mail it
613 return if ($ok and not $::opt_n) || $body;
614 # Check that we have a report that has some, eh, report in it.
617 open(REP, "<$filename");
618 # a strange way to check whether any significant editing
619 # have been done: check whether any new non-empty lines
620 # have been added. Yes, the below code ignores *any* space
624 $unseen++ if $_ ne '' and not exists $REP{$_};
627 while ($unseen == 0) {
629 I am sorry but it looks like you did not report anything.
631 print "Action (Retry Edit/Cancel) ";
632 my ($action) = scalar(<>);
633 if ($action =~ /^[re]/i) { # <R>etry <E>dit
635 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
642 1 while unlink($filename); # remove all versions under VMS
643 print "\nCancelling.\n";
648 # Report is done, prompt for further action
652 Now that you have completed your report, would you like to send
653 the message to $address$andcc, display the message on
654 the screen, re-edit it, or cancel without sending anything?
655 You may also save the message as a file to mail at another time.
658 print "Action (Send/Display/Edit/Cancel/Save to File): ";
659 my $action = scalar <>;
662 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
663 print "\n\nName of file to save message in [perlbug.rep]: ";
664 my $file = scalar <>;
666 $file = "perlbug.rep" if $file eq "";
668 unless (open(FILE, ">$file")) {
669 print "\nError opening $file: $!\n\n";
672 open(REP, "<$filename");
673 print FILE "To: $address\nSubject: $subject\n";
674 print FILE "Cc: $cc\n" if $cc;
675 print FILE "Reply-To: $from\n" if $from;
677 while (<REP>) { print FILE }
681 print "\nMessage saved in `$file'.\n";
683 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
684 # Display the message
685 open(REP, "<$filename");
686 while (<REP>) { print $_ }
688 } elsif ($action =~ /^se/i) { # <S>end
690 print "Are you certain you want to send this message?\n"
691 . 'Please type "yes" if you are: ';
692 my $reply = scalar <STDIN>;
694 if ($reply eq "yes") {
698 That wasn't a clear "yes", so I won't send your message. If you are sure
699 your message should be sent, type in "yes" (without the quotes) at the
703 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
706 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
708 } elsif ($action =~ /^s/) {
710 I'm sorry, but I didn't understand that. Please type "send" or "save".
718 # Message has been accepted for transmission -- Send the message
720 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
724 $msg = new Mail::Send Subject => $subject, To => $address;
725 $msg->cc($cc) if $cc;
726 $msg->add("Reply-To",$from) if $from;
729 open(REP, "<$filename");
730 while (<REP>) { print $fh $_ }
734 print "\nMessage sent.\n";
736 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
737 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
739 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
740 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
742 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
743 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
745 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
746 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
750 (leaving bug report in $filename): $sts
755 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
756 $sendmail = $_, last if -e $_;
758 if ($^O eq 'os2' and $sendmail eq "") {
759 my $path = $ENV{PATH};
761 my @path = split /$Config{'path_sep'}/, $path;
763 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
764 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
768 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
769 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
770 the perl package Mail::Send has not been installed, so I can't send your bug
771 report. We apologize for the inconvenience.
773 So you may attempt to find some way of sending your message, it has
774 been left in the file `$filename'.
776 open(SENDMAIL, "|$sendmail -t") || die "'|$sendmail -t' failed: $!";
778 print SENDMAIL "To: $address\n";
779 print SENDMAIL "Subject: $subject\n";
780 print SENDMAIL "Cc: $cc\n" if $cc;
781 print SENDMAIL "Reply-To: $from\n" if $from;
782 print SENDMAIL "\n\n";
783 open(REP, "<$filename");
784 while (<REP>) { print SENDMAIL $_ }
787 if (close(SENDMAIL)) {
788 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
790 warn "\nSendmail returned status '", $? >> 8, "'\n";
793 1 while unlink($filename); # remove all versions under VMS
799 A program to help generate bug reports about perl5, and mail them.
800 It is designed to be used interactively. Normally no arguments will
804 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
805 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
806 $0 [-v] [-r returnaddress] [-ok | -okay | -nok | -nokay]
808 Simplest usage: run "$0", and follow the prompts.
812 -v Include Verbose configuration data in the report
813 -f File containing the body of the report. Use this to
814 quickly send a prepared message.
815 -F File to output the resulting mail message to, instead of mailing.
816 -S Send without asking for confirmation.
817 -a Address to send the report to. Defaults to `$address'.
818 -c Address to send copy of report to. Defaults to `$cc'.
819 -C Don't send copy to administrator.
820 -s Subject to include with the message. You will be prompted
821 if you don't supply one on the command line.
822 -b Body of the report. If not included on the command line, or
823 in a file with -f, you will get a chance to edit the message.
824 -r Your return address. The program will ask you to confirm
825 this if you don't give it here.
827 -t Test mode. The target address defaults to `$testaddress'.
828 -d Data mode (the default if you redirect or pipe output.)
829 This prints out your configuration data, without mailing
830 anything. You can use this with -v to get more complete data.
831 -ok Report successful build on this system to perl porters
832 (use alone or with -v). Only use -ok if *everything* was ok:
833 if there were *any* problems at all, use -nok.
834 -okay As -ok but allow report from old builds.
835 -nok Report unsuccessful build on this system to perl porters
836 (use alone or with -v). You must describe what went wrong
837 in the body of the report which you will be asked to edit.
838 -nokay As -nok but allow report from old builds.
839 -h Print this help message.
845 my $dir = $Is_VMS ? 'sys$scratch:'
846 : ($Is_MSWin32 && $ENV{'TEMP'}) ? $ENV{'TEMP'}
847 : $Is_MacOS ? $ENV{'TMPDIR'}
849 $filename = "bugrep0$$";
850 # $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
851 $filename++ while -e catfile($dir, $filename);
852 $filename = catfile($dir, $filename);
856 my @paragraphs = split /\n{2,}/, "@_";
858 for (@paragraphs) { # implicit local $_
866 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
874 perlbug - how to submit bug reports on Perl
878 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
879 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
880 S<[ B<-r> I<returnaddress> ]>
881 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
882 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]>
884 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
885 S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
889 A program to help generate bug reports about perl or the modules that
890 come with it, and mail them.
892 If you have found a bug with a non-standard port (one that was not part
893 of the I<standard distribution>), a binary distribution, or a
894 non-standard module (such as Tk, CGI, etc), then please see the
895 documentation that came with that distribution to determine the correct
896 place to report bugs.
898 C<perlbug> is designed to be used interactively. Normally no arguments
899 will be needed. Simply run it, and follow the prompts.
901 If you are unable to run B<perlbug> (most likely because you don't have
902 a working setup to send mail that perlbug recognizes), you may have to
903 compose your own report, and email it to B<perlbug@perl.com>. You might
904 find the B<-d> option useful to get summary information in that case.
906 In any case, when reporting a bug, please make sure you have run through
911 =item What version of Perl you are running?
913 Type C<perl -v> at the command line to find out.
915 =item Are you running the latest released version of perl?
917 Look at http://www.perl.com/ to find out. If it is not the latest
918 released version, get that one and see whether your bug has been
919 fixed. Note that bug reports about old versions of Perl, especially
920 those prior to the 5.0 release, are likely to fall upon deaf ears.
921 You are on your own if you continue to use perl1 .. perl4.
923 =item Are you sure what you have is a bug?
925 A significant number of the bug reports we get turn out to be documented
926 features in Perl. Make sure the behavior you are witnessing doesn't fall
927 under that category, by glancing through the documentation that comes
928 with Perl (we'll admit this is no mean task, given the sheer volume of
929 it all, but at least have a look at the sections that I<seem> relevant).
931 Be aware of the familiar traps that perl programmers of various hues
932 fall into. See L<perltrap>.
934 Check in L<perldiag> to see what any Perl error message(s) mean.
935 If message isn't in perldiag, it probably isn't generated by Perl.
936 Consult your operating system documentation instead.
938 If you are on a non-UNIX platform check also L<perlport>, as some
939 features may be unimplemented or work differently.
941 Try to study the problem under the Perl debugger, if necessary.
944 =item Do you have a proper test case?
946 The easier it is to reproduce your bug, the more likely it will be
947 fixed, because if no one can duplicate the problem, no one can fix it.
948 A good test case has most of these attributes: fewest possible number
949 of lines; few dependencies on external commands, modules, or
950 libraries; runs on most platforms unimpeded; and is self-documenting.
952 A good test case is almost always a good candidate to be on the perl
953 test suite. If you have the time, consider making your test case so
954 that it will readily fit into the standard test suite.
956 Remember also to include the B<exact> error messages, if any.
957 "Perl complained something" is not an exact error message.
959 If you get a core dump (or equivalent), you may use a debugger
960 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
961 report. NOTE: unless your Perl has been compiled with debug info
962 (often B<-g>), the stack trace is likely to be somewhat hard to use
963 because it will most probably contain only the function names and not
964 their arguments. If possible, recompile your Perl with debug info and
965 reproduce the dump and the stack trace.
967 =item Can you describe the bug in plain English?
969 The easier it is to understand a reproducible bug, the more likely it
970 will be fixed. Anything you can provide by way of insight into the
971 problem helps a great deal. In other words, try to analyze the
972 problem (to the extent you can) and report your discoveries.
974 =item Can you fix the bug yourself?
976 A bug report which I<includes a patch to fix it> will almost
977 definitely be fixed. Use the C<diff> program to generate your patches
978 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
979 package, so you should be able to get it from any of the GNU software
980 repositories). If you do submit a patch, the cool-dude counter at
981 perlbug@perl.com will register you as a savior of the world. Your
982 patch may be returned with requests for changes, or requests for more
983 detailed explanations about your fix.
985 Here are some clues for creating quality patches: Use the B<-c> or
986 B<-u> switches to the diff program (to create a so-called context or
987 unified diff). Make sure the patch is not reversed (the first
988 argument to diff is typically the original file, the second argument
989 your changed file). Make sure you test your patch by applying it with
990 the C<patch> program before you send it on its way. Try to follow the
991 same style as the code you are trying to patch. Make sure your patch
992 really does work (C<make test>, if the thing you're patching supports
995 =item Can you use C<perlbug> to submit the report?
997 B<perlbug> will, amongst other things, ensure your report includes
998 crucial information about your version of perl. If C<perlbug> is unable
999 to mail your report after you have typed it in, you may have to compose
1000 the message yourself, add the output produced by C<perlbug -d> and email
1001 it to B<perlbug@perl.com>. If, for some reason, you cannot run
1002 C<perlbug> at all on your system, be sure to include the entire output
1003 produced by running C<perl -V> (note the uppercase V).
1005 Whether you use C<perlbug> or send the email manually, please make
1006 your Subject line informative. "a bug" not informative. Neither is
1007 "perl crashes" nor "HELP!!!". These don't help.
1008 A compact description of what's wrong is fine.
1012 Having done your bit, please be prepared to wait, to be told the bug
1013 is in your code, or even to get no reply at all. The Perl maintainers
1014 are busy folks, so if your problem is a small one or if it is difficult
1015 to understand or already known, they may not respond with a personal reply.
1016 If it is important to you that your bug be fixed, do monitor the
1017 C<Changes> file in any development releases since the time you submitted
1018 the bug, and encourage the maintainers with kind words (but never any
1019 flames!). Feel free to resend your bug report if the next released
1020 version of perl comes out and your bug is still present.
1028 Address to send the report to. Defaults to `perlbug@perl.com'.
1032 Body of the report. If not included on the command line, or
1033 in a file with B<-f>, you will get a chance to edit the message.
1037 Don't send copy to administrator.
1041 Address to send copy of report to. Defaults to the address of the
1042 local perl administrator (recorded when perl was built).
1046 Data mode (the default if you redirect or pipe output). This prints out
1047 your configuration data, without mailing anything. You can use this
1048 with B<-v> to get more complete data.
1056 File containing the body of the report. Use this to quickly send a
1061 File to output the results to instead of sending as an email. Useful
1062 particularly when running perlbug on a machine with no direct internet
1067 Prints a brief summary of the options.
1071 Report successful build on this system to perl porters. Forces B<-S>
1072 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1073 prompts for a return address if it cannot guess it (for use with
1074 B<make>). Honors return address specified with B<-r>. You can use this
1075 with B<-v> to get more complete data. Only makes a report if this
1076 system is less than 60 days old.
1080 As B<-ok> except it will report on older systems.
1084 Report unsuccessful build on this system. Forces B<-C>. Forces and
1085 supplies a value for B<-s>, then requires you to edit the report
1086 and say what went wrong. Alternatively, a prepared report may be
1087 supplied using B<-f>. Only prompts for a return address if it
1088 cannot guess it (for use with B<make>). Honors return address
1089 specified with B<-r>. You can use this with B<-v> to get more
1090 complete data. Only makes a report if this system is less than 60
1095 As B<-nok> except it will report on older systems.
1099 Your return address. The program will ask you to confirm its default
1100 if you don't use this option.
1104 Send without asking for confirmation.
1108 Subject to include with the message. You will be prompted if you don't
1109 supply one on the command line.
1113 Test mode. The target address defaults to `perlbug-test@perl.com'.
1117 Include verbose configuration data in the report.
1123 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1124 by Gurusamy Sarathy (E<lt>gsar@umich.eduE<gt>), Tom Christiansen
1125 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1126 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1127 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1128 Hugo van der Sanden (E<lt>hv@crypt0.demon.co.ukE<gt>),
1129 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), hris Nandor
1130 (E<lt>pudge@pobox.comE<gt>), and Jon Orwant (E<lt>orwant@media.mit.eduE<gt>).
1134 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1135 diff(1), patch(1), dbx(1), gdb(1)
1139 None known (guess what must have been used to report them?)
1145 close OUT or die "Can't close $file: $!";
1146 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1147 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';