Skip to content

Commit

Permalink
clarify documentation of build and builder priorities
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustin J. Mitchell committed Oct 22, 2010
1 parent 64bd138 commit 462cd9f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
26 changes: 26 additions & 0 deletions master/docs/cfg-builders.texinfo
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
@menu
* Builder Configuration::
* Prioritizing Builds::
@end menu

@node Builder Configuration
@subsection Builder Configuration

@bcindex c['builders']

The @code{c['builders']} key is a list of objects giving configuration for the
Expand Down Expand Up @@ -132,5 +140,23 @@ later on like other properties. @pxref{WithProperties}.

@end table

@node Prioritizing Builds
@subsection Prioritizing Builds

The @code{BuilderConfig} parameter @code{nextBuild} can be use to prioritize
build requests within a builder. Note that this is orthogonal to
@pxref{Prioritizing Builders}, which controls the order in which builders are
called on to start their builds.

@example
def nextBuild(bldr, requests):
for r in requests:
if r.source.branch == 'release':
return r
return requests[0]
c['builders'] = [
BuilderConfig(name='test', factory=f,
slavenames=['slave1', 'slave2', 'slave3', 'slave4']),
]
@end example
4 changes: 4 additions & 0 deletions master/docs/cfg-global.texinfo
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@ should return a list of @code{Builder} objects in the desired order.
It may also remove items from the list if builds should not be started
on those builders.

This parameter controls the order in which builders are activated. It does not
affect the order in which a builder processes the build requests in its queue.
For that purpose, see @pxref{Prioritizing Builds}.

@example
def prioritizeBuilders(buildmaster, builders):
"""Prioritize builders. 'finalRelease' builds have the highest
Expand Down

0 comments on commit 462cd9f

Please sign in to comment.