Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
Vitali Lovich committed May 17, 2015
1 parent 1444e32 commit 8721f23
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions master/docs/manual/cfg-buildsteps.rst
Expand Up @@ -144,6 +144,8 @@ Arguments common to all :class:`BuildStep` subclasses:

``locks``
a list of ``Locks`` (instances of :class:`buildbot.locks.SlaveLock` or :class:`buildbot.locks.MasterLock`) that should be acquired before starting this :class:`Step`.
Alternatively this could be a renderable that returns this list during build execution.
This lets you defer picking the locks to acquire until the build step is about to start running.
The ``Locks`` will be released when the step is complete.
Note that this is a list of actual :class:`Lock` instances, not names.
Also note that all Locks must have unique names.
Expand Down
2 changes: 2 additions & 0 deletions master/docs/manual/cfg-interlocks.rst
Expand Up @@ -138,6 +138,8 @@ Each slave performs the same checkout, make, and test build step sequence.
We want to enforce that at most one test step is executed between all slaves due to restrictions with the data base server.
This is done by adding the ``locks=`` parameter with the third step.
It takes a list of locks with their access mode.
Alternatively, this can take a renderable that returns an list of locks with their access mode.

In this case only the :data:`db_lock` is needed.
The exclusive access mode is used to ensure there is at most one slave that executes the test step.

Expand Down

0 comments on commit 8721f23

Please sign in to comment.