VCS::LibCVS::IgnoreChecker - Ask it if a file should be ignored.


VCS-LibCVS documentation  | view source Contained in the VCS-LibCVS distribution.

Index


NAME

Top

VCS::LibCVS::IgnoreChecker - Ask it if a file should be ignored.

SYNOPSIS

Top

  my $ignorer = VCS::LibCVS::IgnoreChecker->new($repository);
  if ( $ignorer->ignore_check("dir1/file1") ) {

DESCRIPTION

Top

CVS has an involved way of deciding which files should be ignored, and which shouldn't. Create an IgnoreChecker, and ask it if a file should be ignored.

The CVSROOT directory in the repository contains some information about what to ignore, so you'll need a Repository to create an IgnoreChecker.

See the CVS info page for which files are ignored.

CLASS ROUTINES

Top

new()

$ignorer = VCS::LibCVS::IgnoreChecker->new($repository)

return type: VCS::LibCVS::IgnoreChecker
argument 1 type: VCS::LibCVS::Repository

The repository from which to retrieve global information.

Creates a new IgnoreChecker, for a specific repository.

INSTANCE ROUTINES

Top

ignore_check()

if ($ignorer->ignore_check("module/file1")) {

return type: boolean scalar

Returns true if the file is ignored by CVS

argument 1 type: scalar string

Filename to check. The filename must be qualified with its directory name so that the .cvsignore in that directory may be checked. The path may be relative or absolute.

Checks if the file should be ignored. See CVS info page for how this is done.

SEE ALSO

Top

  VCS::LibCVS


VCS-LibCVS documentation  | view source Contained in the VCS-LibCVS distribution.