Skip to content

Commit

Permalink
fix docs for createAbsoluteSourceStamps scheduler parameter
Browse files Browse the repository at this point in the history
* this is not a common parameter (applicable only for
  SingleBranchScheduler and Nigthly schedulers)
* for simplicity just copy the docs to two places
  • Loading branch information
Mikhail Sobolev authored and djmitche committed Feb 27, 2015
1 parent bbf742c commit 5002c31
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions master/docs/manual/cfg-schedulers.rst
Expand Up @@ -88,11 +88,6 @@ There are several common arguments for schedulers, although not all are availabl
``reason``
A string that will be used as the reason for the triggered build.

``createAbsoluteSourceStamps``
This option only has effect when using multiple codebases.
When ``True``, it uses the last seen revision for each codebase that does not have a change.
When ``False``, the default value, codebases without changes will use the revision from the ``codebases`` argument.

The remaining subsections represent a catalog of the available scheduler types.
All these schedulers are defined in modules under :mod:`buildbot.schedulers`, and the docstrings there are the best source of documentation on the arguments taken by each one.

Expand Down Expand Up @@ -234,7 +229,9 @@ The arguments to this scheduler are:
``reason``

``createAbsoluteSourceStamps``
See :ref:`Configuring-Schedulers`.
This option only has effect when using multiple codebases.
When ``True``, it uses the last seen revision for each codebase that does not have a change.
When ``False``, the default value, codebases without changes will use the revision from the ``codebases`` argument.

``treeStableTimer``
The scheduler will wait for this many seconds before starting the build.
Expand Down Expand Up @@ -456,7 +453,9 @@ The full list of parameters is:
``codebases``

``createAbsoluteSourceStamps``
See :ref:`Configuring-Schedulers`.
This option only has effect when using multiple codebases.
When ``True``, it uses the last seen revision for each codebase that does not have a change.
When ``False``, the default value, codebases without changes will use the revision from the ``codebases`` argument.

``onlyIfChanged``
If this is true, then builds will not be scheduled at the designated time *unless* the specified branch has seen an important change since the previous build.
Expand Down

0 comments on commit 5002c31

Please sign in to comment.