Alex Taler > VCS-LibCVS > VCS::LibCVS::WorkingFileOrDirectory

Download:
VCS-LibCVS-1.0002.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  2
View Bugs
Report a bug
Source  

NAME ^

VCS::LibCVS::WorkingFileOrDirectory - Something checked out with CVS.

SYNOPSIS ^

DESCRIPTION ^

A WorkingFileOrDirectory is the working version of something checked out of CVS. It implements a small amount of common functionality between files and directories.

The filename used to contruct the object may be relative or absolute, and is stored as such, so be careful if you changed the current directory.

There should be no need to create this object directly. Use WorkingFile and WorkingDirectory instead.

CLASS ROUTINES ^

new()

$working_thing = VCS::LibCVS::WorkingFileOrDirectory->new($filename)

return type: VCS::LibCVS::WorkingFileOrDirectory
argument 1 type: scalar string

The name of a file or directory which is under CVS control.

Creates a new WorkingFileOrDirectory. There's little good reason to call this constructor, instead you'll want to call the constructors of WorkingFile and WorkingDirectory, since they provide the fun routines.

The filename used to contruct the object may be relative or absolute, and is stored as such.

INSTANCE ROUTINES ^

get_name()

$name = $r_obj->get_name({abs => 1})

return type: scalar string
argument 1 type: hash ref of options

All options default to false.

  $opts->{abs}     False: Don't return absolute filename
  $opts->{no_dir}  False: Include directory names
  $opts->{no_base} False: Include the filename within the directory

Returns the filename of the object with the repository, formatted according to the options.

get_repository()

$rep = $l_obj->get_repository()

return type: VCS::LibCVS::Repository

Returns the repository in which this managed object lives.

It reads the CVS sandbox administrative directory to get this info.

get_remote_object()

$r_obj = $l_obj->get_remote_object()

return type: VCS::LibCVS::ManagedObject

Returns the remote object associated with this local object.

It reads the CVS sandbox administrative directory to get this info.

get_branch()

$branch = $l_obj->get_branch()

return type: VCS::LibCVS::Branch

Returns the branch this local object is on.

If there is no sticky branch tag, it returns the MAIN branch.

SEE ALSO ^

  VCS::LibCVS