Skip to content

Commit

Permalink
more repo/proj documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustin J. Mitchell committed Mar 11, 2010
1 parent 8dd807c commit 41dd614
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 2 deletions.
3 changes: 3 additions & 0 deletions buildbot/changes/bonsaipoller.py
Expand Up @@ -221,6 +221,9 @@ def __init__(self, bonsaiURL, module, branch, tree="default",
@type pollInterval: int
@param pollInterval: The time (in seconds) between queries for
changes
@type project: string
@param project: project to attach to all Changes from this changesource
"""

self.bonsaiURL = bonsaiURL
Expand Down
8 changes: 8 additions & 0 deletions docs/cfg-buildsteps.texinfo
Expand Up @@ -277,6 +277,14 @@ running on.
If the build was started from a scheduler, then this property will
contain the name of that scheduler.

@item repository

The repository of the sourcestamp for this build

@item project

The project of the sourcestamp for this build

@end table

@node Source Checkout
Expand Down
19 changes: 18 additions & 1 deletion docs/cfg-changesources.texinfo
Expand Up @@ -137,6 +137,19 @@ that @code{ChangeSource}. Files which are outside this sub-tree are
ignored by the changesource: it does not generate Changes for those
files.

@heading Repository and Project

ChangeSources will, in general, automatically provide the proper 'repository'
attribute for any changes they produce. For systems which operate on URL-like
specifiers, this is a repository URL. Other ChangeSources adapt the concept as
necessary.

Many ChangeSources allow you to specify a project, as well. This attribute is
useful when building from several distinct codebases in the same buildmaster:
the project string can serve to differentiate the different codebases.
Schedulers can filter on project, so you can configure different builders to
run for each project.

@node CVSToys - PBService
@subsection CVSToys - PBService

Expand Down Expand Up @@ -663,6 +676,11 @@ life, it is considered as safe to disable the signal restriction in
the Apache setting like that @code{WSGIRestrictSignal Off}. Refer to the
documentation of your web server for other way to do the same.

The @code{category} parameter sets the category for any changes generated from
the hook. Likewise, the @code{project} parameter sets the project. Changes'
@code{repository} attributes are formed from the Mercurial repo path by
stripping @code{strip} slashes.

@node Bzr Hook
@subsubsection Bzr Hook

Expand Down Expand Up @@ -798,7 +816,6 @@ changed since the last query.
Please take a look at the BonsaiPoller docstring for details about the
arguments it accepts.


@node SVNPoller
@subsection SVNPoller

Expand Down
11 changes: 10 additions & 1 deletion docs/cmdline.texinfo
Expand Up @@ -570,7 +570,16 @@ included in this Change must be on the same branch.
@item --category
(or option @code{category}) This provides the (string) category specifier. If
omitted, it defaults to None, indicating ``no category''. The category property
is used by Schedulers to filter what changes they listen to.
can be used by Schedulers to filter what changes they listen to.

@item --project
(or option @code{project}) This provides the (string) project to which this
change applies, and defaults to ''. The project can be used by schedulers to
decide which builders should respond to a particular change.

@item --repository
(or option @code{repository}) This provides the repository from which this
change came, and defaults to ''.

@item --revision_number
This provides a (numeric) revision number for the change, used for VC systems
Expand Down

0 comments on commit 41dd614

Please sign in to comment.