VCS::Which::Plugin::Subversion - The Subversion plugin for VCS::Which
This documentation refers to VCS::Which::Plugin::Subversion version 0.1.0.
use VCS::Which::Plugin::Subversion; # Brief but working code example(s) here showing the most common usage(s) # This section will be as far as many users bother reading, so make it as # educational and exemplary as possible.
Plugin to provide access to the Subversion version control system
installed ()
Return: bool - True if the Subversion is installed
Description: Determines if Subversion is actually installed and usable
used ($dir)
Param: $dir - string - Directory to check
$dir
Return: bool - True if the directory is versioned by this Subversion
Description: Determines if the directory is under version control of this Subversion
uptodate ($dir)
Return: bool - True if the directory has no uncommitted changes
Description: Determines if the directory has no uncommitted changes
cat ( $file[, $revision] )
Param: $file - string - The name of the file to cat
$file
Param: $revision - string - The revision to get. If the revision is negative it refers to the number of revisions old is desired. Any other value is assumed to be a version control specific revision. If no revision is specified the most recent revision is returned.
$revision
Return: The file contents of the desired revision
Description: Gets the contents of a specific revision of a file.
log ( @args )
TO DO: Body
versions ( [$file], [@args] )
Description: Gets all the versions of $file
pull ( [$dir] )
Description: Pulls or updates the directory $dir to the newest version
There are no known bugs in this module.
Please report problems to Ivan Wills (ivan.wills@gmail.com).
Patches are welcome.
Ivan Wills - (ivan.wills@gmail.com)
Copyright (c) 2009 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW, Australia 2077). All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
To install VCS::Which, copy and paste the appropriate command in to your terminal.
cpanm
cpanm VCS::Which
CPAN shell
perl -MCPAN -e shell install VCS::Which
For more information on module installation, please visit the detailed CPAN module installation guide.