[Buildbot-commits] buildbot/buildbot/status builder.py,1.47,1.48

[Brian Warner]

Update of /cvsroot/buildbot/buildbot/buildbot/status
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8250/buildbot/status

Modified Files:
	builder.py 
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-42
Creator:  Brian Warner <warner at monolith.lothar.com>

merge doc updates [org.apestaart at thomas/buildbot--doc--0--patch-6]

Merge epydoc changes from Thomas, add some hacks of my own. No code
changes to the buildbot itself, although I hacked docs/epyrun a bit.


Index: builder.py
===================================================================
RCS file: /cvsroot/buildbot/buildbot/buildbot/status/builder.py,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -d -r1.47 -r1.48
--- builder.py	1 Apr 2005 01:01:12 -0000	1.47
+++ builder.py	18 Apr 2005 00:26:58 -0000	1.48
@@ -287,6 +287,24 @@
 
 
 class BuildStepStatus:
+    """
+    I represent a collection of output status for a
+    L{buildbot.process.step.BuildStep}.
+
+    @type color: string
+    @cvar color: color that this step feels best represents its
+                 current mood. yellow,green,red,orange are the
+                 most likely choices, although purple indicates
+                 an exception
+    @type progress: L{buildbot.status.progress.StepProgress}
+    @cvar progress: tracks ETA for the step
+    @type text: list of strings
+    @cvar text: list of short texts that describe the command and its status
+    @type text2: list of strings
+    @cvar text2: list of short texts added to the overall build description
+    @type logs: dict of string -> L{buildbot.status.builder.LogFile}
+    @ivar logs: logs of steps
+    """
     # note that these are created when the Build is set up, before each
     # corresponding BuildStep has started.
     __implements__ = interfaces.IBuildStepStatus, interfaces.IStatusEvent
@@ -376,13 +394,18 @@
         return self.color
 
     def getResults(self):
-        """Return a tuple describing the results of the step: (result,
-        strings). 'result' is one of the constants in buildbot.status.builder:
-        SUCCESS, WARNINGS, FAILURE, or SKIPPED. 'strings' is an optional
-        list of strings that the step wants to append to the overall build's
-        results. These strings are usually more terse than the ones returned
-        by getText(): in particular, successful Steps do not usually
-        contribute any text to the overall build."""
+        """Return a tuple describing the results of the step.
+        'result' is one of the constants in L{buildbot.status.builder}:
+        SUCCESS, WARNINGS, FAILURE, or SKIPPED.
+        'strings' is an optional list of strings that the step wants to
+        append to the overall build's results. These strings are usually
+        more terse than the ones returned by getText(): in particular,
+        successful Steps do not usually contribute any text to the
+        overall build.
+
+        @rtype:   tuple of int, list of strings
+        @returns: (result, strings)
+        """
         return (self.results, self.text2)
 
     # subscription interface
@@ -1388,6 +1411,9 @@
             builder_status.subscribe(t)
 
     def builderAdded(self, name, basedir):
+        """
+        @rtype: L{BuilderStatus}
+        """
         filename = os.path.join(self.basedir, basedir, "builder")
         log.msg("trying to load status pickle from %s" % filename)
         builder_status = None