Package buildbot :: Package steps :: Module python_twisted :: Class ProcessDocs

Class ProcessDocs

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

I build all docs. This requires some LaTeX packages to be installed. It will result in the full documentation book (dvi, pdf, etc).

Instance Methods

__init__(self, **kwargs)

source code

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

getText(self, cmd, results)

source code

getText2(self, cmd, results)
We have decided to add a short note about ourselves to the overall build description, probably because something went wrong.

source code

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

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, 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 = `'process-docs'`
	warnOnWarnings = `1`
	command = `['admin/process-docs']` a list of renderable objects (typically strings or WithProperties instances).
	description = `['processing', 'docs']`
	descriptionDone = `['docs']`
Inherited from `shell.ShellCommand`: `flunkOnFailure` Inherited from `process.buildstep.LoggingBuildStep`: `parms`, `progressMetrics` Inherited from `process.buildstep.BuildStep`: `alwaysRun`, `doStepIf`, `flunkOnWarnings`, `haltOnFailure`, `locks`, `useProgress`, `warnOnFailure`

Instance Variables

Inherited from shell.ShellCommand: lazylogfiles, logfiles

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

Method Details

init(self, **kwargs)
(Constructor)

source code

Parameters:

workdir (string) - the workdir to start from: must be the base of the Twisted tree

Overrides: process.buildstep.BuildStep.__init__

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)

getText(self, cmd, results)

source code

Overrides: process.buildstep.LoggingBuildStep.getText

getText2(self, cmd, results)

source code

We have decided to add a short note about ourselves to the overall build description, probably because something went wrong. Return a short list of short strings. If your subclass counts test failures or warnings of some sort, this is a good place to announce the count.

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

Class ProcessDocs

__init__(self, **kwargs) (Constructor)

createSummary(self, log)

evaluateCommand(self, cmd)

getText(self, cmd, results)

getText2(self, cmd, results)

init(self, **kwargs)
(Constructor)