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 - Put
7       source-control keywords in every file.
8

AFFILIATION

10       This Policy is part of the core Perl::Critic distribution.
11

DESCRIPTION

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

CONFIGURATION

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

AUTHOR

42       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>
43

45       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights
46       reserved.
47
48       This program is free software; you can redistribute it and/or modify it
49       under the same terms as Perl itself.  The full text of this license can
50       be found in the LICENSE file included with this module.
51
52
53
54perl v5.16.3          Perl::Critic2:0:1P4o-l0i6c-y1:0:Miscellanea::RequireRcsKeywords(3)
Impressum