perl::critic::policy::miscellanea::requirercskeywords(3pm) [debian man page]
Perl::Critic::Policy::Miscellanea::RequireRcsKeywords(3pUser Contributed Perl DocumentatPerl::Critic::Policy::Miscellanea::RequireRcsKeywords(3pm) NAME
Perl::Critic::Policy::Miscellanea::RequireRcsKeywords - Put source-control keywords in every file. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
Every code file, no matter how small, should be kept in a source-control repository. Adding the magical RCS keywords to your file helps the reader know where the file comes from, in case he or she needs to modify it. This Policy scans your file for comments that look like this: # $Revision: 4106 $ # $Source: /myproject/lib/foo.pm $ A common practice is to use the "Revision" keyword to automatically define the $VERSION variable like this: our ($VERSION) = '$Revision: 4106 $' =~ m{ $Revision: s+ (S+) }x; CONFIGURATION
By default, this policy only requires the "Revision", "Source", and "Date" keywords. To specify alternate keywords, specify a value for "keywords" of a whitespace delimited series of keywords (without the dollar-signs). This would look something like the following in a .perlcriticrc file: [Miscellanea::RequireRcsKeywords] keywords = Revision Source Date Author Id See the documentation on RCS for a list of supported keywords. Many source control systems are descended from RCS, so the keywords supported by CVS and Subversion are probably the same. AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. perl v5.14.2 2012-06-07 Perl::Critic::Policy::Miscellanea::RequireRcsKeywords(3pm)
Check Out this Related Man Page
Perl::Critic::Policy::ValuesAndExpressions::RequireInterUsertContrPerl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm) NAME
Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars - Warns that you might have used single quotes when you really wanted double-quotes. AFFILIATION
This Policy is part of the core Perl::Critic distribution. DESCRIPTION
This policy warns you if you use single-quotes or "q//" with a string that has unescaped metacharacters that may need interpolation. Its hard to know for sure if a string really should be interpolated without looking into the symbol table. This policy just makes an educated guess by looking for metacharacters and sigils which usually indicate that the string should be interpolated. Exceptions o Variable names to "use vars": use vars '$x'; # ok use vars ('$y', '$z'); # ok use vars qw< $a $b >; # ok o Things that look like e-mail addresses: print 'john@foo.com'; # ok $address = 'suzy.bar@baz.net'; # ok CONFIGURATION
The "rcs_keywords" option allows you to stop this policy from complaining about things that look like RCS variables, for example, in deriving values for $VERSION variables. For example, if you've got code like our ($VERSION) = (q<$Revision: 4106 $> =~ m/(d+)/mx); You can specify [ValuesAndExpressions::RequireInterpolationOfMetachars] rcs_keywords = Revision in your .perlcriticrc to provide an exemption. NOTES
Perl's own "warnings" pragma also warns you about this. SEE ALSO
Perl::Critic::Policy::ValuesAndExpressions::ProhibitInterpolationOfLiterals AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. perl v5.14.2 Perl::Critic::Policy::ValuesAndExpressions::RequireInterpolationOfMetachars(3pm)