/ 
VCS-LibCVS-1.0002
River stage zero No dependents
/ VCS::LibCVS::Admin

NAME

VCS::LibCVS::Admin - The CVS sandbox administrative directory.

SYNOPSIS

$admin_dir = VCS::LibCVS::Admin->new("/home/alex/wrk/libcvs/Perl");
$entries = $admin->get_Entries;
$tag = $admin->get_Tag;

DESCRIPTION

Admin represents the administrative information used for managing the checked-out files in the sandbox. Each instance of Admin reprsents this information for the contents of a single directory.

In order to be compatible with other CVS implementations, the default is to use a subdirectory of the indicated directory named "CVS". It should contain at least the three files "Entries", "Root" and "Repository". To use a different name, change $VCS::LibCVS::Admin_Dir_Name.

The administrative information is accessed through objects which are subclasses of LibCVS::Datum.

CLASS ROUTINES

new()

$admin_dir = Admin->new($directory_name)

return type: VCS::LibCVS::Admin

A new Admin.

argument 1 type: scalar string

The name of directory in the file system. This should not end in a slash.

Creates a new Admin. The administrative information is assumed to be in a subdirectory called CVS (or value of $VCS::LibCVS::Admin_Dir_Name) of the specified directory.

INSTANCE ROUTINES

get_dir_name()

$dir_name = $admin->get_dir_name()

return type: scalar string

Returns the name of the local directory whose administrative data this object represents.

get_Entries()

$entries = $admin->get_Entries()

return type: ref to hash

keys are filenames as strings, values are VCS::LibCVS::Datum::Entry

Returns the list of CVS managed files in the directory. They are stored in a hash with relative filenames as keys and LibCVS::Datum::Entry objects as values.

get_Root()

$root = $admin->get_Root()

return type: LibCVS::Datum::Root

Returns the CVS Root for the directory.

get_Repository()

$rep_dir = $admin->get_Repository()

return type: VCS::LibCVS::Datum::DirectoryName

Returns the name of the repository directory for this directory, relative to the root of the repository.

get_Tag()

$tag = $admin->get_Tag()

return type: LibCVS::Datum::TagSpec

Returns the sticky tag specification for this directory. If there is no sticky tag, it returns undef.

SEE ALSO

VCS::LibCVS::Datum