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 Perl::Critic::More, a bleeding edge supplement
11       to Perl::Critic.
12

DESCRIPTION

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

CONFIGURATION

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

AUTHOR

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

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