summaryrefslogtreecommitdiff
path: root/pod/perlmodstyle.pod
diff options
context:
space:
mode:
authorEd J <etj@cpan.org>2014-09-16 07:06:23 +0100
committerFather Chrysostomos <sprout@cpan.org>2014-09-24 21:54:38 -0700
commit69520e41a46ec3b965c16d2280719fe904dc844a (patch)
treebb3991b7fa71d073c9d29ce256ce97510b3cbeca /pod/perlmodstyle.pod
parentd48bd569994962e4f87f68fdcd86ddbd6f9ab1f7 (diff)
downloadperl-69520e41a46ec3b965c16d2280719fe904dc844a.tar.gz
perlmod and perlstyle improvements
• Outward links for perlmod • Tweak perlmodstyle version notes • Link perlnewmod to perlmodstyle
Diffstat (limited to 'pod/perlmodstyle.pod')
-rw-r--r--pod/perlmodstyle.pod13
1 files changed, 10 insertions, 3 deletions
diff --git a/pod/perlmodstyle.pod b/pod/perlmodstyle.pod
index 5622d3244d..5a52eaf9a4 100644
--- a/pod/perlmodstyle.pod
+++ b/pod/perlmodstyle.pod
@@ -630,9 +630,9 @@ don't want CPAN.pm to list it as most recent use an '_' after the
regular version number followed by at least 2 digits, eg. 1.20_01. If
you do this, the following idiom is recommended:
- $VERSION = "1.12_01";
- $XS_VERSION = $VERSION; # only needed if you have XS code
- $VERSION = eval $VERSION;
+ our $VERSION = "1.12_01"; # so CPAN distribution will have right filename
+ our $XS_VERSION = $VERSION; # only needed if you have XS code
+ $VERSION = eval $VERSION; # so "use Module 0.002" won't warn on underscore
With that trick MakeMaker will only read the first line and thus read
the underscore, while the perl interpreter will evaluate the $VERSION
@@ -644,6 +644,13 @@ Never release anything (even a one-word documentation patch) without
incrementing the number. Even a one-word documentation patch should
result in a change in version at the sub-minor level.
+Once picked, it is important to stick to your version scheme, without
+reducing the number of digits. This is because "downstream" packagers,
+such as the FreeBSD ports system, interpret the version numbers in
+various ways. If you change the number of digits in your version scheme,
+you can confuse these systems so they get the versions of your module
+out of order, which is obviously bad.
+
=head2 Pre-requisites
Module authors should carefully consider whether to rely on other