/ 
Perl-Critic-1.084
River stage three • 132 direct dependents • 384 total dependents
/ Perl::Critic::Policy::Miscellanea::RequireRcsKeywords

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: 2401 $
# $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: 2401 $' =~ 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 <thaljef@cpan.org>

COPYRIGHT

Copyright (c) 2005-2008 Jeffrey Ryan Thalhammer. 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.