1CPANPLUS::Hacking(3pm) Perl Programmers Reference Guide CPANPLUS::Hacking(3pm)
2
6 CPANPLUS::Hacking
7
9 This document attempts to describe how to develop with the CPANPLUS
10 environment most easily, how certain things work and why.
11 This is basically a quick-start guide to people who want to add
13 features or patches to CPANPLUS.
14
16 Checkout CPANPLUS from its Subversion repository at
17 http://oss.dwim.org/cpanplus-devel <http://oss.dwim.org/cpanplus-devel>
18 .
19
21 CPANPLUS follows the standard perl module installation process:
22 perl Makefile.PL
24 make
25 make test
26 make install
27
29 When running "perl Makefile.PL" you will be prompted to configure. If
30 you have already done so, and merely wish to update the "Makefile",
31 simply run:
32 perl Makefile.PL JFDI=1
34 This will keep your configuration intact. Note however, if there are
36 changes to the default configuration file "Config.pm-orig", you should
37 either delete your current config file and reconfigure, or patch your
38 config file from the new entries in "Config.pm-orig".
39
41 If you'd rather not install the development version to your "site_perl"
42 directory, that's no problem. You can set your "PERL5LIB" environment
43 variable to CPANPLUS' "lib" directory, and you can run it from there.
44
46 Tests are what tells us if CPANPLUS is working. If a test is not
47 working, try to run it explicilty like this:
48 perl -I/path/to/cpanplus/lib t/XX_name_of_test.t 1
50 The extra '1' makes sure that all the messages and errors (they might
52 be errors we're testing for!) are being printed rather than kept quiet.
53 This is a great way to find out the context of any failures that may
54 occur.
55 If you believe this test failure proves a bug in CPANPLUS, the long
57 output of the test file is something we'd like to see alongside your
58 bug report.
59
61 Sometimes you might find bugs in CPANPLUS' behaviour. If you encounter
62 these in a development snapshot, we'd appreciate a complete patch (as
63 described below in the "SENDING PATCHES" section.
64 If it's way over your head, then of course reporting the bug is always
66 better than not reporting it at all. Before you do so though, make sure
67 you have the latest development snapshot, and the bug still persists
68 there. If so, report the bug to this address:
69 cpanplus-devel@lists.sourceforge.net
71 A good "patch" would have the following characteristics:
73 Problem description
75 Describe clearly what the bug is you found, and what it should have
76 done instead.
77 Program demonstrating the bug
79 Show us how to reproduce the bug, in a simple of a program as
80 possible
81 [OPTIONAL] A patch to the test suite to test for the bug
83 Amend our test suite by making sure this bug will be found in this,
84 and future versions of CPANPLUS (see "SUPPLYING PATCHES")
85 [OPTIONAL] A patch to the code + tests + documentation
87 Fix the bug, update the docs & tests. That way your bug will be
88 gone forever :)
89
91 Patches are a good thing, and they are welcome. Especially if they fix
92 bugs you've found along the way, or that others have reported.
93 We prefer patches in the following format:
95 · In "diff -u" or "diff -c" format
97 · From the root of the snapshot
99 · Including patches for code + tests + docs
101 · Sent per mail to cpanplus-devel@lists.sourceforge.net
103 · With subject containing "[PATCH]" + description of the patch
105 You will always be informed if a patch is applied or rejected, and in
107 case of rejection why that is (perhaps you can tweak the patch to have
108 it accepted after all).
109perl v5.12.4 2011-06-07 CPANPLUS::Hacking(3pm)