Perl::Critic::Policy::Compatibility::PodMinimumVersion

NAME

Perl::Critic::Policy::Compatibility::PodMinimumVersion - check Perl version declared against POD features used

DESCRIPTION

This policy is part of the "Perl::Critic::Pulp" add-on. It checks that the POD features you use don’t exceed your target Perl version as indicated by "use 5.008" etc.

use 5.005;
=pod
C<< something >> # bad, double angles needs 5.006

POD doesn’t affect how the code runs, so this policy is low severity, and under the "compatibility" theme (see "POLICY THEMES" in Perl::Critic).

See "Pod::MinimumVersion" for the POD version checks applied. The key idea is for example when targeting Perl 5.005 you avoid things like double-angles "C<< >>", since "pod2man" in 5.005 didn’t support them. It may be possible to get newer versions of the POD translators from CPAN, but whether they run on an older Perl and whether you want to require that of users is another matter.

Adding the sort of "use 5.006" etc to declare a target Perl can be a bit tedious. The config option below lets you set a base version you use. As always if you don’t care at all about this sort of thing you can disable the policy from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),

[-Compatibility::PodMinimumVersion]

"RequirePodLinksIncludeText" Policy
The "Documentation::RequirePodLinksIncludeText" policy asks you to use the "L<target|display>" style always. That feature is new in Perl 5.005 and will be reported by "PodMinimumVersion" unless you’ve got use 5.005 or higher or set "above_version" below.

CONFIGURATION

"above_version" (version string, default none)

Report only things about Perl versions above this. The string is anything the "version.pm" module understands. For example if you always use Perl 5.6 or higher then set

[Compatibility::PodMinimumVersion]
above_version = 5.006

The effect is that all POD features up to and including Perl 5.6 are allowed, only things above that will be reported (and still only those exceeding any "use 5.xxx" in the file).

HOME PAGE

<http://user42.tuxfamily.org/perl-critic-pulp/index.html>

COPYRIGHT

Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.

pdf