NAME
VCS::Which::Plugin - Base class for the various VCS plugins
VERSION
This documentation refers to VCS::Which::Plugin version 0.1.
SYNOPSIS
use VCS::Which::Plugin;
# 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.DESCRIPTION
SUBROUTINES/METHODS
new ( $search, )
Param: $search - type (detail) - description
Return: VCS::Which::Plugin -
Description:
name ()
Return: string - The pretty name for the System
Description: Returns the pretty name for the VCS
exe ()
Return: string - The name of the executable that is used to run operations with the appropriate plugin
Description: Returns name of the executable for the appropriate version control system.
installed ()
Return: bool - True if the VCS is installed
Description: Determines if VCS is actually installed and usable
used ($dir)
Param: $dir - string - Directory to check
Return: bool - True if the directory is versioned by this VCS
Description: Determines if the directory is under version control of this VCS
uptodate ($dir)
Param: $dir - string - Directory to check
Return: bool - True if the directory has no uncommitted changes
Description: Determines if the directory has no uncommitted changes
exec (@params)
Param: @params - array of strings - The parameters that you wish to pass on to the vcs program.
Description: Runs a command for the appropriate vcs.
DIAGNOSTICS
CONFIGURATION AND ENVIRONMENT
DEPENDENCIES
INCOMPATIBILITIES
BUGS AND LIMITATIONS
There are no known bugs in this module.
Please report problems to Ivan Wills (ivan.wills@gmail.com).
Patches are welcome.
AUTHOR
Ivan Wills - (ivan.wills@gmail.com)
LICENSE AND COPYRIGHT
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.