Package buildbot :: Package steps :: Module python :: Class BuildEPYDoc

Class BuildEPYDoc

   process.buildstep.BuildStep --+        
                                 |        
process.buildstep.LoggingBuildStep --+    
                                     |    
                    shell.ShellCommand --+
                                         |
                                        BuildEPYDoc

Instance Methods

createSummary(self, log)
To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)

source code

evaluateCommand(self, cmd)
Decide whether the command was SUCCESS, WARNINGS, or FAILURE.

source code

Inherited from shell.ShellCommand: __init__, checkForOldSlaveAndLogfiles, describe, setCommand, setDefaultWorkdir, setStepStatus, setupEnvironment, start

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuild, setBuildSlave, setProgress, setProperty, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
	name = `'epydoc'`
	command = `['make', 'epydocs']` a list of renderable objects (typically strings or WithProperties instances).
	description = `['building', 'epydocs']`
	descriptionDone = `['epydoc']`
Inherited from `shell.ShellCommand`: `flunkOnFailure` Inherited from `process.buildstep.LoggingBuildStep`: `cmd`, `parms`, `progressMetrics` Inherited from `process.buildstep.BuildStep`: `alwaysRun`, `doStepIf`, `flunkOnWarnings`, `haltOnFailure`, `locks`, `useProgress`, `warnOnFailure`, `warnOnWarnings`

Instance Variables

Inherited from shell.ShellCommand: lazylogfiles, logfiles

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

createSummary(self, log)

source code

To create summary logs, do something like this: warnings = grep('^Warning:', log.getText()) self.addCompleteLog('warnings', warnings)

Overrides: process.buildstep.LoggingBuildStep.createSummary: (inherited documentation)

evaluateCommand(self, cmd)

source code

Decide whether the command was SUCCESS, WARNINGS, or FAILURE. Override this to, say, declare WARNINGS if there is any stderr activity, or to say that rc!=0 is not actually an error.

Overrides: process.buildstep.LoggingBuildStep.evaluateCommand: (inherited documentation)