1Perl::Critic::Policy::MUPisesercrle:lC:loCanrntiertaii:bc:u:Rt:eePqdouliPireceryRl:c:sDMKoiecsyucwmeoelrnldtasan(te3ia)o:n:RequireRcsKeywords(3)
2
3
4

NAME

6       Perl::Critic::Policy::Miscellanea::RequireRcsKeywords
7

DESCRIPTION

9       Every code file, no matter how small, should be kept in a source-con‐
10       trol repository.  Adding the magical RCS keywords to your file helps
11       the reader know where the file comes from, in case he or she needs to
12       modify it.  This Policy scans your file for comments that look like
13       this:
14
15         # $Revision: 1323 $
16         # $Source: /myproject/lib/foo.pm $
17
18       A common practice is to use the "Revision" keyword to automatically
19       define the $VERSION variable like this:
20
21         our ($VERSION) = '$Revision: 1323 $' =~ m{ \$Revision: \s+ (\S+) }x;
22

CONFIGURATION

24       By default, this policy only requires the "Revision", "Source", and
25       "Date" keywords.  To specify alternate keywords, specify a value for
26       "keywords" of a whitespace delimited series of keywords (without the
27       dollar-signs).  This would look something like the following in a
28       .perlcriticrc file:
29
30         [Miscellanea::RequireRcsKeywords]
31         keywords = Revision Source Date Author Id
32
33       See the documentation on RCS for a list of supported keywords.  Many
34       source control systems are descended from RCS, so the keywords sup‐
35       ported by CVS and Subversion are probably the same.
36

AUTHOR

38       Jeffrey Ryan Thalhammer <thaljef@cpan.org>
39

41       Copyright (c) 2005-2007 Jeffrey Ryan Thalhammer.  All rights reserved.
42
43       This program is free software; you can redistribute it and/or modify it
44       under the same terms as Perl itself.  The full text of this license can
45       be found in the LICENSE file included with this module.
46
47
48
49perl v5.8.8           Perl::Critic2:0:0P7o-l0i3c-y2:0:Miscellanea::RequireRcsKeywords(3)
Impressum