From 6290f2dd4b125b14c13f0533fd77274ffb2e8ab9 Mon Sep 17 00:00:00 2001 From: Bryce Adelstein-Lelbach Date: Fri, 28 Sep 2012 17:13:47 -0500 Subject: [PATCH] Adding docs for builder descriptions. --- master/docs/developer/config.rst | 4 ++++ master/docs/manual/cfg-builders.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/master/docs/developer/config.rst b/master/docs/developer/config.rst index 9eb1ceb8e4c..307e931d693 100644 --- 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 index b32511f9f90..d680f00581a 100644 --- 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: