Package buildslave :: Package commands :: Module bk :: Class BK
[frames] | no frames]

Class BK

source code

      base.Command --+    
                     |    
base.SourceBaseCommand --+
                         |
                        BK

BitKeeper-specific VC operation. In addition to the arguments handled by SourceBaseCommand, this command reads the following keys:

['bkurl'] (required): the BK repository string

Instance Methods
 
setup(self, args)
Override this in a subclass to extract items from the args dict.
source code
 
sourcedirIsUpdateable(self)
Returns True if the tree can be updated.
source code
 
doVCUpdate(self)
Returns a deferred with the steps to update a checkout.
source code
 
doVCFull(self)
Returns a deferred with the steps to do a fresh checkout.
source code
 
getBKVersionCommand(self)
Get the (shell) command used to determine BK revision number of checked-out code
source code
 
parseGotRevision(self)
Override this in a subclass.
source code

Inherited from base.SourceBaseCommand: doClobber, doClobberTryChmodIfFail, doCopy, doPatch, doVC, doVCFallback2, getCommand, interrupt, maybeClobber, maybeDoVCFallback, maybeDoVCRetry, maybeNotDoVCFallback, readSourcedata, setFileContents, sourcedataMatches, sourcedirIsPatched, start, writeSourcedata

Inherited from base.Command: __init__, __providedBy__, __provides__, doInterrupt, doStart, sendStatus

Class Variables
  header = 'bk operation'

Inherited from base.SourceBaseCommand: sourcedata

Inherited from base.Command: __implemented__, debug, interrupted, running

Method Details

setup(self, args)

source code 

Override this in a subclass to extract items from the args dict.

Overrides: base.Command.setup
(inherited documentation)

sourcedirIsUpdateable(self)

source code 

Returns True if the tree can be updated.

Overrides: base.SourceBaseCommand.sourcedirIsUpdateable
(inherited documentation)

doVCUpdate(self)

source code 

Returns a deferred with the steps to update a checkout.

Overrides: base.SourceBaseCommand.doVCUpdate
(inherited documentation)

doVCFull(self)

source code 

Returns a deferred with the steps to do a fresh checkout.

Overrides: base.SourceBaseCommand.doVCFull
(inherited documentation)

getBKVersionCommand(self)

source code 

Get the (shell) command used to determine BK revision number of checked-out code

return: list of strings, passable as the command argument to RunProcess

parseGotRevision(self)

source code 

Override this in a subclass. It should return a string that represents which revision was actually checked out, or a Deferred that will fire with such a string. If, in a future build, you were to pass this 'got_revision' string in as the 'revision' component of a SourceStamp, you should wind up with the same source code as this checkout just obtained.

It is probably most useful to scan self.command.stdout for a string of some sort. Be sure to set keepStdout=True on the VC command that you run, so that you'll have something available to look at.

If this information is unavailable, just return None.

Overrides: base.SourceBaseCommand.parseGotRevision
(inherited documentation)