/ 
VCS-Lite-Repository-0.12
River stage zero No dependents
/ VCS::Lite::Element

NAME

VCS::Lite::Element - Minimal Version Control System - Element object

SYNOPSIS

use VCS::Lite::Element;
my $ele=VCS::Lite::Element->new('/home/me/dev/testfile.c');
my $lit=$ele->fetch( generation => 2);
$ele->check_in( description => 'Fix the bug');
$ele->update;
$ele->commit;

DESCRIPTION

A VCS::Lite::Repository contains elements corresponding to the source files being version controlled. The files are real files on the local file system, but additional information about the element is held inside the repository.

This information includes the history of the element, in terms of its generations.

METHODS

new

my $ele=VCS::Lite::Element->new('/home/me/dev/testfile.c');

Constructs a VCS::Lite::Element for a given element in a repository. Returns undef if the element is not found in the repository.

repository

Create a repository object from the current path.

traverse

Does nothing currently.

fetch

my $lit=$ele->fetch( generation => 2);
my $lit2=$ele->fetch( time => '2003-12-29T12:01:25');

The fetch method is used to retrieve generations from the repository. If no time or generation is specified, the latest generation is retrieved. The method returns a VCS::Lite object if successful or undef.

check_in

$ele->check_in( description => 'Fix bug in foo method');

This method creates a new latest generation in the repository for the element.

update

$ele->update;

This applies any changes to $ele which have happened in the parent repository, i.e. the one that the current repository was checked out from.

commit

$ele->commit;

Applies the latest generation change to the parent repository. Note: this updates the file inside the parent file tree; a call to update is required to update the repository.

SEE ALSO

VCS::Lite::Repository, VCS::Lite.

BUGS, PATCHES & FIXES

There are no known bugs at the time of this release. However, if you spot a bug or are experiencing difficulties that are not explained within the POD documentation, please send an email to barbie@cpan.org or submit a bug to the RT system (see link below). However, it would help greatly if you are able to pinpoint problems or even supply a patch.

http://rt.cpan.org/Public/Dist/Display.html?Name=VCS-Lite-Repository

Fixes are dependent upon their severity and my availability. Should a fix not be forthcoming, please feel free to (politely) remind me.

AUTHOR

Original Author: Ivor Williams (RIP)          2002-2009
Current Maintainer: Barbie <barbie@cpan.org>  2014-2015

COPYRIGHT

Copyright (c) Ivor Williams, 2002-2009
Copyright (c) Barbie,        2014-2015

LICENCE

This distribution is free software; you can redistribute it and/or modify it under the Artistic Licence v2.