1CPANPLUS::Hacking(3) User Contributed Perl Documentation CPANPLUS::Hacking(3)
2
6 CPANPLUS::Hacking
7
9 This document attempts to describe how to easiest develop with the
10 CPANPLUS environment, how certain things work and why.
11 This is basically a quick-start guide to people who want to add fea‐
13 tures or patches to CPANPLUS.
14
16 CPANPLUS offers snapshots from the stable and unstable branches. After
17 every patch to either of the branches, the snapshot is automatically
18 updated.
19 You can find the stable branch here (which should be equal to the CPAN
21 release): <http://p4.elixus.org/snap/cpanplus-dist.tar.gz>
22 And the development branch here: <http://p4.elixus.org/snap/cpan‐
24 plus-devel.tar.gz>
25
27 CPANPLUS follows the standard perl module installation process:
28 perl Makefile.PL
30 make
31 make test
32 make install
33
35 When running "perl Makefile.PL" you will be prompted to configure. If
36 you have already done so, and merely wish to update the "Makefile",
37 simply run:
38 perl Makefile.PL JFDI=1
40 This will keep your configuration intact. Note however, if there are
42 changes to the default configuration file "Config.pm-orig", you should
43 either delete your current config file and reconfigure, or patch your
44 config file from the new entries in "Config.pm-orig".
45
47 If you'd rather not install the development version to your "site_perl"
48 directory, that's no problem. You can set your "PERL5LIB" environment
49 variable to CPANPLUS' "lib" directory, and you can run it from there.
50
52 Tests are what tells us if CPANPLUS is working. If a test is not work‐
53 ing, try to run it explicilty like this:
54 perl -I/path/to/cpanplus/lib t/XX_name_of_test.t 1
56 The extra '1' makes sure that all the messages and errors (they might
58 be errors we're testing for!) are being printed rather than kept quiet.
59 This is a great way to find out the context of any failures that may
60 occur.
61 If you believe this test failure proves a bug in CPANPLUS, the long
63 output of the test file is something we'd like to see alongside your
64 bug report.
65
67 Sometimes you might find bugs in CPANPLUS' behaviour. If you encounter
68 these in a development snapshot, we'd appreciate a complete patch (as
69 described below in the "SENDING PATCHES" section.
70 If it's way over your head, then of course reporting the bug is always
72 better than not reporting it at all. Before you do so though, make sure
73 you have the latest development snapshot, and the bug still persists
74 there. If so, report the bug to this address:
75 cpanplus-devel@lists.sourceforge.net
77 A good "patch" would have the following characteristics:
79 Problem description
81 Describe clearly what the bug is you found, and what it should have
82 done instead.
83 Program demonstrating the bug
85 Show us how to reproduce the bug, in a simple of a program as pos‐
86 sible
87 [OPTIONAL] A patch to the test suite to test for the bug
89 Amend our test suite by making sure this bug will be found in this,
90 and future versions of CPANPLUS (see "SUPPLYING PATCHES")
91 [OPTIONAL] A patch to the code + tests + documentation
93 Fix the bug, update the docs & tests. That way your bug will be
94 gone forever :)
95
97 Patches are a good thing, and they are welcome. Especially if they fix
98 bugs you've found along the way, or that others have reported.
99 We prefer patches in the following format:
101 * In "diff -u" or "diff -c" format
103 * From the root of the snapshot
104 * Including patches for code + tests + docs
105 * Sent per mail to cpanplus-devel@lists.sourceforge.net
106 * With subject containing "[PATCH]" + description of the patch
107 You will always be informed if a patch is applied or rejected, and in
109 case of rejection why that is (perhaps you can tweak the patch to have
110 it accepted after all).
111perl v5.8.8 2007-03-31 CPANPLUS::Hacking(3)