1Bugs(3)               User Contributed Perl Documentation              Bugs(3)
2
3
4

NAME

6       PDL::Bugs - How to diagnose and report PDL problems
7

VERSION

9       version 1.0000
10

DESCRIPTION

12       This module explains how to get help with a PDL problem and how, when,
13       and where to submit a bug report.  In the future it may be extended to
14       provide some sort of automated bug reporting capability.
15

IF YOU HAVE A PDL PROBLEM

17       The primary resource for support for the Perl Data Language is via the
18       PDL mailing lists.  The pdl-general list is for general use and
19       discussions and is the one to use for questions about problems with PDL
20       or PDL use for computation.  This is almost always the list to post to
21       for PDL problems.
22
23       The pdl-devel list is specifically for PDL development and often
24       contains discussions of a rather technical nature relating to PDL
25       internals.  This is not the list for general PDL discussion or
26       questions: <http://pdl.perl.org/?page=mailing-lists>.
27
28       NOTE: Both pdl-general and pdl-devel are read by the PDL developers so
29       you don't save time or increase the probability of response by posting
30       to pdl-devel or by cross-posting to pdl-devel.  Please stick to pdl-
31       general list posts unless you want to talk PDL implementation and
32       development.
33
34       NOTE: There is also a PDL IRC channel which can be useful for immediate
35       questions if populated.  However, it has the big disadvantage of not
36       being easily searched or routinely read by all PDL developers and
37       users.  As a result, if you get an answer there, it may be incorrect or
38       incomplete depending on who happens to be chatting at the time.  It is
39       definitely not readily searchable.
40

REPORTING BUGS

42       Please submit bug reports via the GitHub issue tracker at
43       <https://github.com/PDLPorters/pdl/issues>.
44
45       where you can review the previously submitted bug reports.  Click on
46       "New issue" to generate a bug report.  If you do not already have a
47       GitHub account, you will need to create one to submit the report.
48
49       Try to include any information you think might help someone isolate,
50       reproduce, and fix your problem.
51
52       At a minimum, include the following information:
53
54       •   PDL version number (e.g. PDL-2.007)
55
56       •   Perl version information.  Output from "perl -v" or "perl -V" (even
57           better!)
58
59       •   Your operating System.  You can run the "uname -a" command on many
60           unix systems
61
62       •   The full output of "perldl -V"
63
64           If you are reporting a bug with an already installed PDL.  If the
65           PDL has compiled and built but not been installed, you may run
66           "perl -Mblib perldl -V" from the top level of the PDL build
67           directory.
68
69       •   The bug description and how to reproduce it.
70
71           Short examples using the PDL shells, "pdl2" or "perldl", are
72           excellent!  Don't forget to include needed input data (as small as
73           possible) so that the code can be run with a cut and paste.
74
75       Other things that are often helpful:
76
77       •   Details about your operating environment that might be related to
78           the problem
79
80       •   Exact cut and pasted error or warning messages
81
82       •   The shortest, clearest code you can manage to write which
83           reproduces the bug described.
84
85       •   A patch against the latest released version of this distribution
86           which fixes this bug.
87
88       Alternatively, send an e-mail report with the above information
89       (including the output of "perldl -V") to the pdl-devel mailing list.
90       See <http://pdl.perl.org/?page=mailing-lists> for info on how to
91       subscribe to this list.
92

BEFORE YOU SEND A REPORT

94       BEFORE you report a bug make sure you got the latest release version of
95       PDL, always available from CPAN, check <http://metacpan.org/pod/PDL>.
96
97       Also, you can check the FAQ at
98       <http://pdl.perl.org/?docs=FAQ&title=PDL::FAQ>.  and the mailing list
99       archives for hints. You can find links to the searchable archives at
100       <http://pdl.perl.org/?page=mailing-lists>.
101
102       and there is a Google enable search box on the top right of
103       <http://pdl.perl.org> which usually gives the best results.
104

PATCHES

106       Patches can be submitted in several ways, in order of decreasing
107       preference:
108
109       1.  Fork the pdl repository on GitHub, make and test your changes, and
110           submit a pull request;
111
112       2.  Edit (or suggesting an edit to) the files in-place on GitHub;
113
114       3.  Email a patch to the pdl-devel mailing list.
115
116       Patches should be made against the latest released PDL or, ideally,
117       against the current git sources which you can browse and check out at
118       <https://github.com/PDLPorters/pdl>.
119
120       Thanks, The PDL developers.
121
122
123
124perl v5.36.0                      2023-01-20                           Bugs(3)
Impressum