NAME
VCS::Which - <One-line description of module's purpose>
VERSION
This documentation refers to VCS::Which version 0.1.
SYNOPSIS
use VCS::Which;
# 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 -
Description:
load_systems ()
Description: Creates new objects for each version control system found
get_systems ()
Description: Searches for version control systems plugins installed
capabilities ( [$dir] )
Param: $dir - string - Directory to base out put on
Return: list context - The data for each system's capabilities scalar context - A string displaying each system's capabilities
Description: Gets the capabilities of each system and returns the results
which ( $dir )
Param: $dir - string - Directory to work out which system it is using
Return: VCS::Which::Plugin - Object which can be used against the directory
Description: Determines which version control plugin can be used to with the supplied directory.
uptodate ( $dir )
Param: $dir - string - Directory to base out put on
Return: bool - True if the everything is checked in for the directory
Description: Determines if there are any changes that have not been committed to the VCS running the directory.
exec ( @args )
Param: @args - array - Arguments to pass on to the appropriate vcs command
Description: Runs the appropriate vcs command with the parameters supplied
DIAGNOSTICS
A list of every error and warning message that the module can generate (even the ones that will "never happen"), with a full explanation of each problem, one or more likely causes, and any suggested remedies.
CONFIGURATION AND ENVIRONMENT
A full explanation of any configuration system(s) used by the module, including the names and locations of any configuration files, and the meaning of any environment variables or properties that can be set. These descriptions must also include details of any configuration language used.
DEPENDENCIES
A list of all of the other modules that this module relies upon, including any restrictions on versions, and an indication of whether these required modules are part of the standard Perl distribution, part of the module's distribution, or must be installed separately.
INCOMPATIBILITIES
A list of any modules that this module cannot be used in conjunction with. This may be due to name conflicts in the interface, or competition for system or program resources, or due to internal limitations of Perl (for example, many modules that use source code filters are mutually incompatible).
BUGS AND LIMITATIONS
A list of known problems with the module, together with some indication of whether they are likely to be fixed in an upcoming release.
Also, a list of restrictions on the features the module does provide: data types that cannot be handled, performance issues and the circumstances in which they may arise, practical limitations on the size of data sets, special cases that are not (yet) handled, etc.
The initial template usually just has:
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.