SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE




YUM REPOSITORY

 
 

MAN page from Mandriva 2010 perl-File-Find-Rule-VCS-1.60.0-1mdv2010.0.noarch.rpm

File::Find::Rule::VCS

Section: User Contributed Perl Documentation (3)
Updated: 2009-07-08
Index 

NAME

File::Find::Rule::VCS - Exclude files/directories for Version Control Systems 

SYNOPSIS

  use File::Find::Rule      ();  use File::Find::Rule::VCS ();    # Find all files smaller than 10k, ignoring version control files  my @files = File::Find::Rule->ignore_vcs                              ->file                              ->size('<10Ki')                              ->in( $dir );
 

DESCRIPTION

Many tools need to be equally useful both on ordinary files, and on codethat has been checked out from revision control systems.

File::Find::Rule::VCS provides quick and convenient methods toexclude the version control directories of several major VersionControl Systems (currently CVS, subversion, and Bazaar).

File::Find::Rule::VCS implements methods to ignore the following:

CVS
Subversion
Bazaar

In addition, the following version control systems do not createdirectories in the checkout and do not require the use of anyignore methods

SVK
Git
 

METHODS

 

ignore_vcs

  # Ignore all common version control systems  $find->ignore_vcs;    # Ignore a specific named version control systems  $find->ignore_vcs($name);    # Ignore nothing (silent pass-through)  $find->ignore_vcs('');

The "ignore_vcs" method excludes the files for a named Version ControlSystem from your File::Find::Rule search.

If passed, the name of the version control system is case in-sensitive.Names currently supported are 'cvs', 'svn', 'subversion', 'bzr', and'bazaar'.

As a convenience for high-level APIs, if the VCS name is the definednull string '' then the call will be treated as a nullop.

If no params at all are passed, this method will ignore all supportedversion control systems. If ignoring every version control system,please note that any legitimate directories called ``CVS'' or filesstarting with .# will be ignored, which is not always desirable.

In widely-distributed code, you instead should try to detect the specificversion control system used and call ignore_vcs with the specific name.

Passing "undef", or an unsupported name, will throw an exception. 

ignore_cvs

The "ignore_cvs" method excluding all CVS directories from yourFile::Find::Rule search.

It will also exclude all the files left around by CVS after anautomated merge that start with '.#' (dot-hash). 

ignore_svn

The "ignore_svn" method excluding all Subversion (".svn") directoriesfrom your File::Find::Rule search. 

ignore_bzr

The "ignore_bzr" method excluding all Bazaar (".bzr") directoriesfrom your File::Find::Rule search. 

TO DO

- Add support for other version control systems.

- Add other useful VCS-related methods 

SUPPORT

Bugs should always be submitted via the CPAN bug tracker

<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Find-Rule-VCS>

For other issues, contact the maintainer 

AUTHOR

Adam Kennedy <adamkAATTcpan.org> 

SEE ALSO

<http://ali.as/>, File::Find::Rule 

COPYRIGHT

Copyright 2005 - 2009 Adam Kennedy.

This program is free software; you can redistributeit and/or modify it under the same terms as Perl itself.

The full text of the license can be found in theLICENSE file included with this module.


 

Index

NAME
SYNOPSIS
DESCRIPTION
METHODS
ignore_vcs
ignore_cvs
ignore_svn
ignore_bzr
TO DO
SUPPORT
AUTHOR
SEE ALSO
COPYRIGHT

This document was created byman2html,using the manual pages.