NAME
VCS::Which::Plugin::Bazaar - The Bazaar plugin for VCS::Which
VERSION
This documentation refers to VCS::Which::Plugin::Bazaar version 0.6.9.
SYNOPSIS
use VCS::Which::Plugin::Bazaar;
# 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
This is the plugin for the Bazaar version control system.
SUBROUTINES/METHODS
name ()
Return: string - The pretty name for the System
Description: Returns the pretty name for the Bazaar
installed ()
Return: bool - True if the Bazaar is installed
Description: Determines if Bazaar is actually installed and usable
used ($dir)
Param: $dir
- string - Directory to check
Return: bool - True if the directory is versioned by this Bazaar
Description: Determines if the directory is under version control of this Bazaar
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
cat ( $file[, $revision] )
Param: $file
- string - The name of the file to cat
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.
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
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.