Adding docs for builder descriptions.

buildbot · Oct 28, 2012 · 6290f2d · 6290f2d
1 parent 71b8281
commit 6290f2d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/master/docs/developer/config.rst b/master/docs/developer/config.rst
@@ -250,6 +250,10 @@ Builder Configuration
 
         The builder's mergeRequests callable.
 
+    .. py:attribute:: description
+
+        The builder's description, displayed in the web status.
+
 Error Handling
 ==============
 

diff --git a/master/docs/manual/cfg-builders.rst b/master/docs/manual/cfg-builders.rst
@@ -122,6 +122,10 @@ Other optional keys may be set on each ``BuilderConfig``:
     specific for this builder in this parameter. Those values can be used
     later on like other properties. :ref:`Interpolate`.
 
+``description``
+    A builder may be given an arbitrary description, which will show up in the
+    web status on the builder's page.
+
 .. index:: Builds; merging
 
 .. _Merging-Build-Requests: