Skip to content

Commit

Permalink
add docs for monotone (fixes #4)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustin J. Mitchell committed Jun 13, 2010
1 parent 4f28d72 commit d64bcb6
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 5 deletions.
42 changes: 40 additions & 2 deletions docs/cfg-buildsteps.texinfo
Expand Up @@ -445,6 +445,7 @@ arguments are described on the following pages.
* P4::
* Git::
* BitKeeper::
* Monotone::
@end menu

@node CVS
Expand Down Expand Up @@ -765,10 +766,13 @@ update to the branch.
@cindex Arch Checkout
@bsindex buildbot.steps.source.Arch

Because Arch is now deprecated in favor of bzr, this step is slated to be
removed in Buildbot-0.8.2.

The @code{Arch} build step performs an @uref{http://gnuarch.org/,
Arch} checkout or update using the @code{tla} client. It takes the
following arguments:
Arch} checkout or update using the @code{tla} client.

The step takes the following arguments:

@table @code
@item url
Expand Down Expand Up @@ -800,6 +804,9 @@ which uses a client named @code{baz}. The checkout semantics are just
different enough from @code{tla} that there is a separate BuildStep for
it.

Because Arch is now deprecated in favor of bzr, this step is slated to be
removed in Buildbot-0.8.2.

It takes exactly the same arguments as @code{Arch}, except that the
@code{archive=} parameter is required. (baz does not emit the archive
name when you do @code{baz register-archive}, so we must provide it
Expand Down Expand Up @@ -950,6 +957,37 @@ slash.

@end table

@node Monotone
@subsubsection Monotone

@cindex Monotone Checkout
@bsindex buildbot.steps.source.Monotone

The @code{Monotone} build step gets source from a @uref{http://monotone.ca/, Monotone}
repository. Note that Monotone support in Buildbot is not currently maintained, has some
serious deficiencies, and is slated to be removed in Buildbot-0.8.2. If a maintainer steps
forward, this removal may be avoided.

Note that this step is incapable of building the "latest" commit on any branch,
and will crash if made to do so. It must always be given an explicit revision.

The step takes the following arguments:

@table @code
@item server_addr
(required): the address of the server to pull from

@item branch
(required): the branch to check out

@item db_path
(required): the local database path to use - an absolute path

@item monotone
the path to the @code{mtn} executable on the slave

@end table

@node ShellCommand
@subsection ShellCommand

Expand Down
7 changes: 4 additions & 3 deletions master/buildbot/steps/source.py
Expand Up @@ -1305,7 +1305,7 @@ class Monotone(Source):
name = "monotone"

def __init__(self, server_addr=None, branch=None, db_path="monotone.db",
monotone="monotone",
monotone=None,
**kwargs):
warn("Support for Monotone will be removed in 0.8.2", DeprecationWarning)
Source.__init__(self, **kwargs)
Expand All @@ -1316,8 +1316,9 @@ def __init__(self, server_addr=None, branch=None, db_path="monotone.db",
)
assert branch, "branch must be specified"
self.args.update({"branch": branch,
"db_path": db_path,
"monotone": monotone})
"db_path": db_path})
if monotone:
self.args["monotone"] = monotone

def computeSourceRevision(self, changes):
if not changes:
Expand Down

0 comments on commit d64bcb6

Please sign in to comment.