.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "File::Find::Rule::VCS 3pm"
.TH File::Find::Rule::VCS 3pm "2023-11-01" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
File::Find::Rule::VCS \- Exclude files/directories for Version Control Systems
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  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(\*(Aq<10Ki\*(Aq)
\&                              \->in( $dir );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Many tools need to be equally useful both on ordinary files, and on code
that has been checked out from revision control systems.
.PP
\&\fBFile::Find::Rule::VCS\fR provides quick and convenient methods to
exclude the version control directories of several major Version
Control Systems (currently \s-1CVS,\s0 subversion, and Bazaar).
.PP
\&\fBFile::Find::Rule::VCS\fR implements methods to ignore the following:
.IP "\fB\s-1CVS\s0\fR" 4
.IX Item "CVS"
.PD 0
.IP "\fBSubversion\fR" 4
.IX Item "Subversion"
.IP "\fBBazaar\fR" 4
.IX Item "Bazaar"
.PD
.PP
In addition, the following version control systems do not create
directories in the checkout and do not require the use of any
ignore methods
.IP "\fB\s-1SVK\s0\fR" 4
.IX Item "SVK"
.PD 0
.IP "\fBGit\fR" 4
.IX Item "Git"
.PD
.SH "METHODS"
.IX Header "METHODS"
.SS "ignore_vcs"
.IX Subsection "ignore_vcs"
.Vb 2
\&  # 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(\*(Aq\*(Aq);
.Ve
.PP
The \f(CW\*(C`ignore_vcs\*(C'\fR method excludes the files for a named Version Control
System from your File::Find::Rule search.
.PP
If passed, the name of the version control system is case in-sensitive.
Names currently supported are 'cvs', 'svn', 'subversion', 'bzr', and
\&'bazaar'.
.PP
As a convenience for high-level APIs, if the \s-1VCS\s0 name is the defined
null string \fB''\fR then the call will be treated as a nullop.
.PP
If no params at all are passed, this method will ignore all supported
version control systems. If ignoring every version control system,
please note that any legitimate directories called \*(L"\s-1CVS\*(R"\s0 or files
starting with .# will be ignored, which is not always desirable.
.PP
In widely-distributed code, you instead should try to detect the specific
version control system used and call ignore_vcs with the specific name.
.PP
Passing \f(CW\*(C`undef\*(C'\fR, or an unsupported name, will throw an exception.
.SS "ignore_cvs"
.IX Subsection "ignore_cvs"
The \f(CW\*(C`ignore_cvs\*(C'\fR method excluding all \s-1CVS\s0 directories from your
File::Find::Rule search.
.PP
It will also exclude all the files left around by \s-1CVS\s0 after an
automated merge that start with \f(CW\*(Aq.#\*(Aq\fR (dot-hash).
.SS "ignore_rcs"
.IX Subsection "ignore_rcs"
The \f(CW\*(C`ignore_rcs\*(C'\fR method excluding all \s-1RCS\s0 directories from your
File::Find::Rule search.
.PP
It will also exclude all the files used by \s-1RCS\s0 to store the revisions
(end with \f(CW\*(Aq,v\*(Aq\fR).
.SS "ignore_svn"
.IX Subsection "ignore_svn"
The \f(CW\*(C`ignore_svn\*(C'\fR method excluding all Subversion (\f(CW\*(C`.svn\*(C'\fR) directories
from your File::Find::Rule search.
.SS "ignore_bzr"
.IX Subsection "ignore_bzr"
The \f(CW\*(C`ignore_bzr\*(C'\fR method excluding all Bazaar (\f(CW\*(C`.bzr\*(C'\fR) directories
from your File::Find::Rule search.
.SS "ignore_git"
.IX Subsection "ignore_git"
The \f(CW\*(C`ignore_git\*(C'\fR method excluding all Git (\f(CW\*(C`.git\*(C'\fR) directories
from your File::Find::Rule search.
.SS "ignore_hg"
.IX Subsection "ignore_hg"
The \f(CW\*(C`ignore_hg\*(C'\fR method excluding all Mercurial/Hg (\f(CW\*(C`.hg\*(C'\fR) directories
from your File::Find::Rule search.
.SH "TO DO"
.IX Header "TO DO"
\&\- Add support for other version control systems.
.PP
\&\- Add other useful VCS-related methods
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs should always be submitted via the \s-1CPAN\s0 bug tracker
.PP
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File\-Find\-Rule\-VCS>
.PP
For other issues, contact the maintainer
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://ali.as/>, File::Find::Rule
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005 \- 2010 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.