summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man1/perlthanks.1perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man1/perlthanks.1perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man1/perlthanks.1perl')
-rw-r--r--upstream/archlinux/man1/perlthanks.1perl331
1 files changed, 331 insertions, 0 deletions
diff --git a/upstream/archlinux/man1/perlthanks.1perl b/upstream/archlinux/man1/perlthanks.1perl
new file mode 100644
index 00000000..e049dff5
--- /dev/null
+++ b/upstream/archlinux/man1/perlthanks.1perl
@@ -0,0 +1,331 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "PERLBUG 1perl"
+.TH PERLBUG 1perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+perlbug \- how to submit bug reports on Perl
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+\&\fBperlbug\fR
+.PP
+\&\fBperlbug\fR [\ \fB\-v\fR\ ] [\ \fB\-a\fR\ \fIaddress\fR\ ] [\ \fB\-s\fR\ \fIsubject\fR\ ]
+[\ \fB\-b\fR\ \fIbody\fR\ |\ \fB\-f\fR\ \fIinputfile\fR\ ] [\ \fB\-F\fR\ \fIoutputfile\fR\ ]
+[\ \fB\-r\fR\ \fIreturnaddress\fR\ ]
+[\ \fB\-e\fR\ \fIeditor\fR\ ] [\ \fB\-c\fR\ \fIadminaddress\fR\ |\ \fB\-C\fR\ ]
+[\ \fB\-S\fR\ ] [\ \fB\-t\fR\ ] [\ \fB\-d\fR\ ] [\ \fB\-h\fR\ ] [\ \fB\-T\fR\ ]
+.PP
+\&\fBperlbug\fR [\ \fB\-v\fR\ ] [\ \fB\-r\fR\ \fIreturnaddress\fR\ ]
+ [\ \fB\-ok\fR\ |\ \fB\-okay\fR\ |\ \fB\-nok\fR\ |\ \fB\-nokay\fR\ ]
+.PP
+\&\fBperlthanks\fR
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+This program is designed to help you generate bug reports
+(and thank-you notes) about perl5 and the modules which ship with it.
+.PP
+In most cases, you can just run it interactively from a command
+line without any special arguments and follow the prompts.
+.PP
+If you have found a bug with a non-standard port (one that was not
+part of the \fIstandard distribution\fR), a binary distribution, or a
+non-core module (such as Tk, DBI, etc), then please see the
+documentation that came with that distribution to determine the
+correct place to report bugs.
+.PP
+Bug reports should be submitted to the GitHub issue tracker at
+<https://github.com/Perl/perl5/issues>. The \fBperlbug@perl.org\fR
+address no longer automatically opens tickets. You can use this tool
+to compose your report and save it to a file which you can then submit
+to the issue tracker.
+.PP
+In extreme cases, \fBperlbug\fR may not work well enough on your system
+to guide you through composing a bug report. In those cases, you
+may be able to use \fBperlbug \-d\fR or \fBperl \-V\fR to get system
+configuration information to include in your issue report.
+.PP
+When reporting a bug, please run through this checklist:
+.IP "What version of Perl you are running?" 4
+.IX Item "What version of Perl you are running?"
+Type \f(CW\*(C`perl \-v\*(C'\fR at the command line to find out.
+.IP "Are you running the latest released version of perl?" 4
+.IX Item "Are you running the latest released version of perl?"
+Look at <http://www.perl.org/> to find out. If you are not using the
+latest released version, please try to replicate your bug on the
+latest stable release.
+.Sp
+Note that reports about bugs in old versions of Perl, especially
+those which indicate you haven't also tested the current stable
+release of Perl, are likely to receive less attention from the
+volunteers who build and maintain Perl than reports about bugs in
+the current release.
+.IP "Are you sure what you have is a bug?" 4
+.IX Item "Are you sure what you have is a bug?"
+A significant number of the bug reports we get turn out to be
+documented features in Perl. Make sure the issue you've run into
+isn't intentional by glancing through the documentation that comes
+with the Perl distribution.
+.Sp
+Given the sheer volume of Perl documentation, this isn't a trivial
+undertaking, but if you can point to documentation that suggests
+the behaviour you're seeing is \fIwrong\fR, your issue is likely to
+receive more attention. You may want to start with \fBperldoc\fR
+perltrap for pointers to common traps that new (and experienced)
+Perl programmers run into.
+.Sp
+If you're unsure of the meaning of an error message you've run
+across, \fBperldoc\fR perldiag for an explanation. If the message
+isn't in perldiag, it probably isn't generated by Perl. You may
+have luck consulting your operating system documentation instead.
+.Sp
+If you are on a non-UNIX platform \fBperldoc\fR perlport, as some
+features may be unimplemented or work differently.
+.Sp
+You may be able to figure out what's going wrong using the Perl
+debugger. For information about how to use the debugger \fBperldoc\fR
+perldebug.
+.IP "Do you have a proper test case?" 4
+.IX Item "Do you have a proper test case?"
+The easier it is to reproduce your bug, the more likely it will be
+fixed \-\- if nobody can duplicate your problem, it probably won't be
+addressed.
+.Sp
+A good test case has most of these attributes: short, simple code;
+few dependencies on external commands, modules, or libraries; no
+platform-dependent code (unless it's a platform-specific bug);
+clear, simple documentation.
+.Sp
+A good test case is almost always a good candidate to be included in
+Perl's test suite. If you have the time, consider writing your test case so
+that it can be easily included into the standard test suite.
+.IP "Have you included all relevant information?" 4
+.IX Item "Have you included all relevant information?"
+Be sure to include the \fBexact\fR error messages, if any.
+"Perl gave an error" is not an exact error message.
+.Sp
+If you get a core dump (or equivalent), you may use a debugger
+(\fBdbx\fR, \fBgdb\fR, etc) to produce a stack trace to include in the bug
+report.
+.Sp
+NOTE: unless your Perl has been compiled with debug info
+(often \fB\-g\fR), the stack trace is likely to be somewhat hard to use
+because it will most probably contain only the function names and not
+their arguments. If possible, recompile your Perl with debug info and
+reproduce the crash and the stack trace.
+.IP "Can you describe the bug in plain English?" 4
+.IX Item "Can you describe the bug in plain English?"
+The easier it is to understand a reproducible bug, the more likely
+it will be fixed. Any insight you can provide into the problem
+will help a great deal. In other words, try to analyze the problem
+(to the extent you can) and report your discoveries.
+.IP "Can you fix the bug yourself?" 4
+.IX Item "Can you fix the bug yourself?"
+If so, that's great news; bug reports with patches are likely to
+receive significantly more attention and interest than those without
+patches. Please submit your patch via the GitHub Pull Request workflow
+as described in \fBperldoc\fR perlhack. You may also send patches to
+\&\fBperl5\-porters@perl.org\fR. When sending a patch, create it using
+\&\f(CW\*(C`git format\-patch\*(C'\fR if possible, though a unified diff created with
+\&\f(CW\*(C`diff \-pu\*(C'\fR will do nearly as well.
+.Sp
+Your patch may be returned with requests for changes, or requests for more
+detailed explanations about your fix.
+.Sp
+Here are a few hints for creating high-quality patches:
+.Sp
+Make sure the patch is not reversed (the first argument to diff is
+typically the original file, the second argument your changed file).
+Make sure you test your patch by applying it with \f(CW\*(C`git am\*(C'\fR or the
+\&\f(CW\*(C`patch\*(C'\fR program before you send it on its way. Try to follow the
+same style as the code you are trying to patch. Make sure your patch
+really does work (\f(CW\*(C`make test\*(C'\fR, if the thing you're patching is covered
+by Perl's test suite).
+.ie n .IP "Can you use ""perlbug"" to submit a thank-you note?" 4
+.el .IP "Can you use \f(CWperlbug\fR to submit a thank-you note?" 4
+.IX Item "Can you use perlbug to submit a thank-you note?"
+Yes, you can do this by either using the \f(CW\*(C`\-T\*(C'\fR option, or by invoking
+the program as \f(CW\*(C`perlthanks\*(C'\fR. Thank-you notes are good. It makes people
+smile.
+.PP
+Please make your issue title informative. "a bug" is not informative.
+Neither is "perl crashes" nor is "HELP!!!". These don't help. A compact
+description of what's wrong is fine.
+.PP
+Having done your bit, please be prepared to wait, to be told the
+bug is in your code, or possibly to get no reply at all. The
+volunteers who maintain Perl are busy folks, so if your problem is
+an obvious bug in your own code, is difficult to understand or is
+a duplicate of an existing report, you may not receive a personal
+reply.
+.PP
+If it is important to you that your bug be fixed, do monitor the
+issue tracker (you will be subscribed to notifications for issues you
+submit or comment on) and the commit logs to development
+versions of Perl, and encourage the maintainers with kind words or
+offers of frosty beverages. (Please do be kind to the maintainers.
+Harassing or flaming them is likely to have the opposite effect of the
+one you want.)
+.PP
+Feel free to update the ticket about your bug on
+<https://github.com/Perl/perl5/issues>
+if a new version of Perl is released and your bug is still present.
+.SH OPTIONS
+.IX Header "OPTIONS"
+.IP \fB\-a\fR 8
+.IX Item "-a"
+Address to send the report to instead of saving to a file.
+.IP \fB\-b\fR 8
+.IX Item "-b"
+Body of the report. If not included on the command line, or
+in a file with \fB\-f\fR, you will get a chance to edit the report.
+.IP \fB\-C\fR 8
+.IX Item "-C"
+Don't send copy to administrator when sending report by mail.
+.IP \fB\-c\fR 8
+.IX Item "-c"
+Address to send copy of report to when sending report by mail.
+Defaults to the address of the
+local perl administrator (recorded when perl was built).
+.IP \fB\-d\fR 8
+.IX Item "-d"
+Data mode (the default if you redirect or pipe output). This prints out
+your configuration data, without saving or mailing anything. You can use
+this with \fB\-v\fR to get more complete data.
+.IP \fB\-e\fR 8
+.IX Item "-e"
+Editor to use.
+.IP \fB\-f\fR 8
+.IX Item "-f"
+File containing the body of the report. Use this to quickly send a
+prepared report.
+.IP \fB\-F\fR 8
+.IX Item "-F"
+File to output the results to. Defaults to \fBperlbug.rep\fR.
+.IP \fB\-h\fR 8
+.IX Item "-h"
+Prints a brief summary of the options.
+.IP \fB\-ok\fR 8
+.IX Item "-ok"
+Report successful build on this system to perl porters. Forces \fB\-S\fR
+and \fB\-C\fR. Forces and supplies values for \fB\-s\fR and \fB\-b\fR. Only
+prompts for a return address if it cannot guess it (for use with
+\&\fBmake\fR). Honors return address specified with \fB\-r\fR. You can use this
+with \fB\-v\fR to get more complete data. Only makes a report if this
+system is less than 60 days old.
+.IP \fB\-okay\fR 8
+.IX Item "-okay"
+As \fB\-ok\fR except it will report on older systems.
+.IP \fB\-nok\fR 8
+.IX Item "-nok"
+Report unsuccessful build on this system. Forces \fB\-C\fR. Forces and
+supplies a value for \fB\-s\fR, then requires you to edit the report
+and say what went wrong. Alternatively, a prepared report may be
+supplied using \fB\-f\fR. Only prompts for a return address if it
+cannot guess it (for use with \fBmake\fR). Honors return address
+specified with \fB\-r\fR. You can use this with \fB\-v\fR to get more
+complete data. Only makes a report if this system is less than 60
+days old.
+.IP \fB\-nokay\fR 8
+.IX Item "-nokay"
+As \fB\-nok\fR except it will report on older systems.
+.IP \fB\-p\fR 8
+.IX Item "-p"
+The names of one or more patch files or other text attachments to be
+included with the report. Multiple files must be separated with commas.
+.IP \fB\-r\fR 8
+.IX Item "-r"
+Your return address. The program will ask you to confirm its default
+if you don't use this option.
+.IP \fB\-S\fR 8
+.IX Item "-S"
+Save or send the report without asking for confirmation.
+.IP \fB\-s\fR 8
+.IX Item "-s"
+Subject to include with the report. You will be prompted if you don't
+supply one on the command line.
+.IP \fB\-t\fR 8
+.IX Item "-t"
+Test mode. Makes it possible to command perlbug from a pipe or file, for
+testing purposes.
+.IP \fB\-T\fR 8
+.IX Item "-T"
+Send a thank-you note instead of a bug report.
+.IP \fB\-v\fR 8
+.IX Item "-v"
+Include verbose configuration data in the report.
+.SH AUTHORS
+.IX Header "AUTHORS"
+Kenneth Albanowski (<kjahds@kjahds.com>), subsequently
+\&\fIdoc\fRtored by Gurusamy Sarathy (<gsar@activestate.com>),
+Tom Christiansen (<tchrist@perl.com>), Nathan Torkington
+(<gnat@frii.com>), Charles F. Randall (<cfr@pobox.com>),
+Mike Guy (<mjtg@cam.ac.uk>), Dominic Dunlop
+(<domo@computer.org>), Hugo van der Sanden (<hv@crypt.org>),
+Jarkko Hietaniemi (<jhi@iki.fi>), Chris Nandor
+(<pudge@pobox.com>), Jon Orwant (<orwant@media.mit.edu>,
+Richard Foley (<richard.foley@rfi.net>), Jesse Vincent
+(<jesse@bestpractical.com>), and Craig A. Berry (<craigberry@mac.com>).
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBperl\fR\|(1), \fBperldebug\fR\|(1), \fBperldiag\fR\|(1), \fBperlport\fR\|(1), \fBperltrap\fR\|(1),
+\&\fBdiff\fR\|(1), \fBpatch\fR\|(1), \fBdbx\fR\|(1), \fBgdb\fR\|(1)
+.SH BUGS
+.IX Header "BUGS"
+None known (guess what must have been used to report them?)