add documentation for Force Scheduler's 'buttonName' argument

buildbot · Apr 3, 2014 · e5ca28e · e5ca28e
1 parent d22261a
commit e5ca28e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/master/docs/manual/cfg-schedulers.rst b/master/docs/manual/cfg-schedulers.rst
@@ -898,6 +898,11 @@ The scheduler takes the following parameters:
     taken as the property name, or ``AnyPropertyParameter``, which allows the
     web user to specify the property name.
 
+``buttonName``
+
+    The name of the "submit" button on the resulting force-build form.
+    This defaults to "Force Build".
+
 An example may be better than long explanation.  What you need in your config
 file is something like::
 

diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst
@@ -146,6 +146,8 @@ Features
 
 * Systemd unit files for Buildbot are available in the :bb:src:`contrib/` directory.
 
+* The :bb:sched:`ForceScheduler` now takes a ``buttonName`` argument to specify the name of the button on the force-build form.
+
 Forward Compatibility
 ~~~~~~~~~~~~~~~~~~~~~