zim.plugins.versioncontrol.VCS

Class Method	`check_dependencies`	Check if the dependencies for the requested vcs are ok @param vcs: the requested vcs: VCS.BZR, VCS.GIT, VCS.HG or VCS.FOSSIL @returns: `True` if dependencies are checked ok.
Class Method	`create`	Build the required instance of a Version Control System
Class Method	`detect_in_folder`	No summary
Class Method	`get_backend`	Return the class of backend to instantiate according to vcs given as parameter. @param vcs: the wanted vcs backend (VCS.BZR, VCS.GIT, VCS.HG, ...) @returns: the related backend class. The returned class is a VCSApplicationBase child class
Constant	`BZR`	Undocumented
Constant	`FOSSIL`	Undocumented
Constant	`GIT`	Undocumented
Constant	`HG`	Undocumented
Class Method	`_detect_in_folder`	Undocumented

@classmethod
def check_dependencies(klass, vcs): (source)

Check if the dependencies for the requested vcs are ok

Parameters
klass	Undocumented
vcs	the requested vcs: VCS.BZR, VCS.GIT, VCS.HG or VCS.FOSSIL
Returns
`True` if dependencies are checked ok.

@classmethod
def create(klass, vcs, vcs_dir, notebook_dir): (source)

Build the required instance of a Version Control System

Parameters
klass	Undocumented
vcs	Version Control System to build (choose between VCS.BZR, VCS.HG, VCS.GIT, VCS.FOSSIL)
vcs_dir	a `Dir` instance representing the VCS root folder
notebook_dir	a `Dir` instance representing the notebook root folder (must be equal to or below vcs_dir)
Returns
a vcs backend object

@classmethod
def detect_in_folder(klass, dir): (source)

Detect if a version control system has already been setup in the folder. It also create the instance by calling the VCS.create() method

Parameters
klass	Undocumented
dir	a `Dir` instance representing the notebook root folder
Returns
a vcs backend object or `None`

@classmethod
def get_backend(klass, vcs): (source)

Return the class of backend to instantiate according to vcs given as parameter.

Parameters
klass	Undocumented
vcs	the wanted vcs backend (VCS.BZR, VCS.GIT, VCS.HG, ...)
Returns
the related backend class. The returned class is a VCSApplicationBase child class

Undocumented

Value

_('Bazaar')

Undocumented

Value

_('Fossil')

Undocumented

Value

_('Git')

Undocumented

Value

_('Mercurial')

@classmethod
def _detect_in_folder(klass, folder): (source)

Undocumented