.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perl::Critic::Policy::Compatibility::PodMinimumVersion 3pm" .TH Perl::Critic::Policy::Compatibility::PodMinimumVersion 3pm "2021-02-28" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Perl::Critic::Policy::Compatibility::PodMinimumVersion \- check Perl version declared against POD features used .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It checks that the \s-1POD\s0 features you use don't exceed your target Perl version as indicated by \f(CW\*(C`use 5.008\*(C'\fR etc. .PP .Vb 1 \& use 5.005; \& \& =pod \& \& C<< something >> # bad, double angles needs 5.006 .Ve .PP \&\s-1POD\s0 doesn't affect how the code runs, so this policy is low severity, and under the \*(L"compatibility\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .PP See \f(CW\*(C`Pod::MinimumVersion\*(C'\fR for the \s-1POD\s0 version checks applied. The key idea is for example when targeting Perl 5.005 you avoid things like double-angles \f(CW\*(C`C<< >>\*(C'\fR, since \f(CW\*(C`pod2man\*(C'\fR in 5.005 didn't support them. It may be possible to get newer versions of the \&\s-1POD\s0 translators from \s-1CPAN,\s0 but whether they run on an older Perl and whether you want to require that of users is another matter. .PP Adding the sort of \f(CW\*(C`use 5.006\*(C'\fR 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 \fI.perlcriticrc\fR in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Compatibility::PodMinimumVersion] .Ve .ie n .SS """RequirePodLinksIncludeText"" Policy" .el .SS "\f(CWRequirePodLinksIncludeText\fP Policy" .IX Subsection "RequirePodLinksIncludeText Policy" The \f(CW\*(C`Documentation::RequirePodLinksIncludeText\*(C'\fR policy asks you to use the \&\f(CW\*(C`L\*(C'\fR style always. That feature is new in Perl 5.005 and will be reported by \f(CW\*(C`PodMinimumVersion\*(C'\fR unless you've got \f(CW\*(C`use 5.005\*(C'\fR or higher or set \f(CW\*(C`above_version\*(C'\fR below. .SH "CONFIGURATION" .IX Header "CONFIGURATION" .ie n .IP """above_version"" (version string, default none)" 4 .el .IP "\f(CWabove_version\fR (version string, default none)" 4 .IX Item "above_version (version string, default none)" Report only things about Perl versions above this. The string is anything the \f(CW\*(C`version.pm\*(C'\fR module understands. For example if you always use Perl 5.6 or higher then set .Sp .Vb 2 \& [Compatibility::PodMinimumVersion] \& above_version = 5.006 .Ve .Sp The effect is that all \s-1POD\s0 features up to and including Perl 5.6 are allowed, only things above that will be reported (and still only those exceeding any \f(CW\*(C`use 5.xxx\*(C'\fR in the file). .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Pod::MinimumVersion, Perl::Critic .PP Perl::Critic::Policy::Documentation::RequirePodLinksIncludeText, Perl::Critic::Policy::Compatibility::PerlMinimumVersionAndWhy, Perl::Critic::Policy::Modules::PerlMinimumVersion .SH "HOME PAGE" .IX Header "HOME PAGE" .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde .PP Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Perl-Critic-Pulp is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Perl-Critic-Pulp. If not, see .