Table of Contents

Class: Cvs eric3/VCS/cvsPackage/cvs.py

Class implementing the version control systems interface to CVS.

Base Classes   
VersionControl
Methods   
__init__
cvsEdit
cvsUnedit
vcsAdd
vcsAddBinary
vcsAddTree
vcsAllRegisteredStates
vcsCheckout
vcsCleanup
vcsCommandLine
vcsCommit
vcsDiff
vcsExists
vcsExport
vcsHistory
vcsImport
vcsInit
vcsLog
vcsLogin
vcsLogout
vcsMerge
vcsName
vcsRegisteredState
vcsRemove
vcsRevert
vcsStatus
vcsSwitch
vcsTag
vcsUpdate
  __init__ 
__init__ (
        self,
        parent=None,
        name=None,
        )

Constructor

Arguments

parent
parent widget (QWidget)
name
name of this object (string or QString)
  cvsEdit 
cvsEdit ( self,  name )

Public method used to edit a file under cvs control.

A list of filenames can be passed in as well. In this case it is assumed, that all files are located in the same directory.

Arguments

name
file name(s) to be edited (string or list of strings)
  cvsUnedit 
cvsUnedit ( self,  name )

Public method used to unedit a file under cvs control.

A list of filenames can be passed in as well. In this case it is assumed, that all files are located in the same directory.

Arguments

name
file name(s) to be unedited (string or list of strings)
  vcsAdd 
vcsAdd (
        self,
        name,
        isDir=0,
        )

Public method used to add a file/directory to the cvs repository.

Arguments

name
file/directory name to be added (string)
isDir
flag indicating name is a directory (boolean)
  vcsAddBinary 
vcsAddBinary (
        self,
        name,
        isDir=0,
        )

Public method used to add a file/directory in binary mode to the cvs repository.

Arguments

name
file/directory name to be added (string)
isDir
flag indicating name is a directory (boolean)
  vcsAddTree 
vcsAddTree ( self,  path )

Public method to add a directory tree rooted at path to the cvs repository.

Arguments

path
root directory of the tree to be added (string)
  vcsAllRegisteredStates 
vcsAllRegisteredStates (
        self,
        names,
        dname,
        )

Public method used to get the registered states of a number of files in the vcs.

Arguments

names
dictionary with all filenames to be checked as keys
dname
directory to check in (string)

Returns

the received dictionary completed with a combination of canBeCommited and canBeAdded or None in order to signal an error

  vcsCheckout 
vcsCheckout (
        self,
        vcsDir,
        project,
        projectDir,
        noDialog=0,
        tag=None,
        )

Public method used to check the project out of the cvs repository.

Arguments

vcsDir
name of the VCS directory (string)
project
name of the archive (string)
projectDir
project directory to create (string)
noDialog
flag indicating quiet operations
tag
tag of version to check out (string)

Returns

flag indicating an execution without errors (boolean)

  vcsCleanup 
vcsCleanup ( self,  name )

Public method used to cleanup the local copy.

Arguments

name
directory name to be cleaned up (string)
  vcsCommandLine 
vcsCommandLine ( self,  name )

Public method used to execute arbitrary cvs commands.

Arguments

name
directory name of the working directory (string)
  vcsCommit 
vcsCommit (
        self,
        name,
        message,
        noDialog=0,
        )

Public method used to make the change of a file/directory permanent in the cvs repository.

Arguments

name
file/directory name to be committed (string)
message
message for this operation (string)
noDialog
flag indicating quiet operations

Returns

flag indicating an execution without errors (boolean)

  vcsDiff 
vcsDiff ( self,  name )

Public method used to view the difference of a file/directory to the cvs repository.

Arguments

name
file/directory name to be diffed (string)
  vcsExists 
vcsExists ( self )

Public method used to test for the presence of the cvs executable.

Returns

flag indicating the existance (boolean)

  vcsExport 
vcsExport (
        self,
        vcsDir,
        project,
        projectDir,
        tag=None,
        )

Public method used to export a directory from the cvs repository.

Arguments

vcsDir
name of the VCS directory (string)
project
name of the archive (string)
projectDir
project directory to create (string)
tag
tag of version to check out (string)

Returns

flag indicating an execution without errors (boolean)

  vcsHistory 
vcsHistory ( self,  name )

Public method used to view the history of a file/directory in the cvs repository.

Arguments

name
file/directory name to show the history for (string)
  vcsImport 
vcsImport (
        self,
        vcsDir,
        message,
        project,
        vendor,
        release,
        projectDir,
        noDialog=0,
        )

Public method used to import the project into the cvs repository.

Arguments

vcsDir
name of the VCS directory (string)
message
message for this operation (string)
project
name of the archive (string)
vendor
vendor string (string)
release
release version string (string)
projectDir
project directory to create (string)
noDialog
flag indicating quiet operations

Returns

flag indicating an execution without errors (boolean)

  vcsInit 
vcsInit (
        self,
        vcsDir,
        noDialog=0,
        )

Public method used to initialize the cvs repository.

Arguments

vcsDir
name of the VCS directory (string)
noDialog
flag indicating quiet operations (boolean)

Returns

flag indicating an execution without errors (boolean)

  vcsLog 
vcsLog ( self,  name )

Public method used to view the log of a file/directory from the cvs repository.

Arguments

name
file/directory name to show the log for (string)
  vcsLogin 
vcsLogin (
        self,
        user,
        passwd,
        host,
        repository,
        )

Public method used to login to the remote repository.

Arguments

user
user name (string)
passwd
password (string)
host
hostname (string)
repository
repository name (string)
  vcsLogout 
vcsLogout (
        self,
        user,
        host,
        repository,
        )

Public method used to logout from the remote repository.

Arguments

user
user name (string)
host
hostname (string)
repository
repository name (string)
  vcsMerge 
vcsMerge ( self,  name )

Public method used to merge a tag/branch into the local project.

Arguments

name
file/directory name to be merged (string)
  vcsName 
vcsName ( self )

Public method returning the name of the vcs.

Returns

always CVS (string)

  vcsRegisteredState 
vcsRegisteredState ( self,  name )

Public method used to get the registered state of a file in the vcs.

Arguments

name
filename to check (string)

Returns

a combination of canBeCommited and canBeAdded or 0 in order to signal an error

  vcsRemove 
vcsRemove (
        self,
        name,
        project=0,
        )

Public method used to remove a file/directory from the cvs repository.

The default operation is to remove the local copy as well.

Arguments

name
file/directory name to be removed (string)
project
flag indicating deletion of a project tree (boolean)

Returns

flag indicating successfull operation (boolean)

  vcsRevert 
vcsRevert ( self,  name )

Public method used to revert changes made to a file/directory.

Arguments

name
file/directory name to be reverted (string)
  vcsStatus 
vcsStatus ( self,  name )

Public method used to view the status of a file in the cvs repository.

Arguments

name
file/directory name to show the status for (string)
  vcsSwitch 
vcsSwitch ( self,  name )

Public method used to switch a directory to a different tag/branch.

Arguments

name
directory name to be switched (string)
  vcsTag 
vcsTag ( self,  name )

Public method used to set the tag of a file/directory in the cvs repository.

Arguments

name
file/directory name to be tagged (string)
  vcsUpdate 
vcsUpdate ( self,  name )

Public method used to update a file/directory with the cvs repository.

Arguments

name
file/directory name to be updated (string)

Table of Contents

This document was automatically generated by HappyDoc version 2.1