[Buildbot-commits] buildbot/docs buildbot.texinfo,1.1,1.2

Brian Warner warner at users.sourceforge.net
Thu May 12 20:10:13 UTC 2005


Update of /cvsroot/buildbot/buildbot/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26118/docs

Modified Files:
	buildbot.texinfo 
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-159
Creator:  Brian Warner <warner at monolith.lothar.com>

buildbot.texinfo updates

Patches applied:

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-15
   Merged from arch at buildbot.sf.net--2004 (patch 147-151)

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-16
   Merged from arch at buildbot.sf.net--2004 (patch 152-155)

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-17
   Merged from arch at buildbot.sf.net--2004 (patch 156-158)

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-18
   more doc updates


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- buildbot.texinfo	11 May 2005 23:25:25 -0000	1.1
+++ buildbot.texinfo	12 May 2005 20:10:11 -0000	1.2
@@ -2041,6 +2041,8 @@
 @node CVS, SVN, Source Checkout, Source Checkout
 @subsubsection CVS
 
+ at cindex CVS Checkout
+
 The @code{CVS} build step performs a CVS checkout or update. It
 takes the following arguments:
 
@@ -2074,6 +2076,8 @@
 @node SVN, Darcs, CVS, Source Checkout
 @subsubsection SVN
 
+ at cindex SVN Checkout
+
 The @code{SVN} build step performs a Subversion checkout or update.
 It takes the following arguments.
 
@@ -2095,6 +2099,8 @@
 @node Darcs, Arch, SVN, Source Checkout
 @subsubsection Darcs
 
+ at cindex Darcs Checkout
+
 The @code{Darcs} build step performs a
 @uref{http://abridgegame.org/darcs/, Darcs} checkout or update. It
 takes the following arguments:
@@ -2108,6 +2114,8 @@
 @node Arch, Bazaar, Darcs, Source Checkout
 @subsubsection Arch
 
+ at cindex Arch Checkout
+
 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:
@@ -2132,6 +2140,8 @@
 @node Bazaar, P4Sync, Arch, Source Checkout
 @subsubsection Bazaar
 
+ at cindex Bazaar Checkout
+
 @code{Bazaar} is an alternate implementation of the Arch VC system,
 which uses a client named @code{baz}. The checkout semantics are just
 different enough from @code{tla} that there is a separate BuildStep for
@@ -2146,6 +2156,8 @@
 @node P4Sync,  , Bazaar, Source Checkout
 @subsubsection P4Sync
 
+ at cindex Perforce Update
+
 The @code{P4Sync} build step performs a
 @uref{http://www.perforce.com/, Perforce} update. It is a temporary
 facility: a more complete P4 checkout step (named @code{P4}) will
@@ -2685,38 +2697,110 @@
 @node HTML Waterfall, IRC Bot, Status Delivery, Status Delivery
 @subsection HTML Waterfall
 
-This creates an HTML ``waterfall display'', which shows a time-based
-chart of events. This display provides detailed information about all
-steps of all recent builds, and provides hyperlinks to look at
-individual build logs and source changes. If the @code{http_port}
-argument is provided, it represents the TCP port number on which the
-web server should listen. If instead @code{distrib_port} is provided,
-a twisted.web distributed server will be started either on a TCP port
-(if @code{distrib_port} is an int) or more likely on a UNIX socket (if
+ at cindex Waterfall
+
+ at example
+from buildbot.status import html
+w = html.Waterfall(http_port=8080)
+c['status'].append(w)
+ at end example
+
+The @code{buildbot.status.html.Waterfall} status target creates an
+HTML ``waterfall display'', which shows a time-based chart of events.
+This display provides detailed information about all steps of all
+recent builds, and provides hyperlinks to look at individual build
+logs and source changes. If the @code{http_port} argument is provided,
+it represents the TCP port number on which the web server should
+listen. If instead @code{distrib_port} is provided, a twisted.web
+distributed server will be started either on a TCP port (if
+ at code{distrib_port} is an int) or more likely on a UNIX socket (if
 @code{distrib_port} is a string). The HTML page can have a favicon and
 custom CSS: see the docstring for details.
 
-The @code{webPathname} option means that, on a host with a
+The @code{distrib_port} option means that, on a host with a
 suitably-configured twisted-web server, you do not need to consume a
 separate TCP port for the buildmaster's status web page. When the web
 server is constructed with @code{mktap web --user}, URLs that point to
 @code{http://host/~username/} are dispatched to a sub-server that is
 listening on a UNIX socket at @code{~username/.twisted-web-pb}. On
 such a system, it is convenient to create a dedicated @code{buildbot}
-user, then set @code{webPathname} to
+user, then set @code{distrib_port} to
 @code{os.path.expanduser("~/.twistd-web-pb")}. This configuration will
 make the HTML status page available at @code{http://host/~buildbot/}.
+Suitable URL remapping can make it appear at
+ at code{http://host/buildbot/}, and the right virtual host setup can
+even place it at @code{http://buildbot.host/}.
 
 @node IRC Bot, PBListener, HTML Waterfall, Status Delivery
 @subsection IRC Bot
 
-This creates an IRC bot which will attach to the given channel(s) and be
-available for status queries. It can also be asked to announce builds as
-they occur, or be told to shut up.
+ at cindex IRC
+
+The @code{buildbot.status.words.IRC} status target creates an IRC bot
+which will attach to certain channels and be available for status
+queries. It can also be asked to announce builds as they occur, or be
+told to shut up.
+
+ at example
+from twisted.status import words
+irc = words.IRC("irc.example.org", "botnickname", 
+                channels=["channel1", "channel2"])
+c['status'].append(irc)
+ at end example
+
+Take a look at the docstring for @code{words.IRC} for more details on
+configuring this service.
+
+To use the service, you address messages at the buildbot, either
+normally (@code{botnickname: status}) or with private messages
+(@code{/msg botnickname status}). The buildbot will respond in kind.
+
+Some of the commands currently available:
+
+ at table @code
+
+ at item list builders
+Emit a list of all configured builders
+ at item status BUILDER
+Announce the status of a specific Builder: what it is doing right now.
+ at item status all
+Announce the status of all Builders
+ at item watch BUILDER
+If the given Builder is currently running, wait until the Build is
+finished and then announce the results.
+ at item last BUILDER
+Return the results of the last build to run on the given Builder.
+
+ at item help COMMAND
+Describe a command. Use @code{help commands} to get a list of known
+commands.
+ at item source
+Announce the URL of the Buildbot's home page.
+ at item version
+Announce the version of this Buildbot.
+ at end table
+
+If the @code{allowForce=True} option was used, some addtional commands
+will be available:
+
+ at table @code
+ at item force build BUILDER REASON
+Tell the given Builder to start a build of the latest code. The user
+requesting the build and REASON are recorded in the Build status. The
+buildbot will announce the build's status when it finishes.
+
+ at item stop build BUILDER REASON
+Terminate any running build in the given Builder. REASON will be added
+to the build status to explain why it was stopped. You might use this
+if you committed a bug, corrected it right away, and don't want to
+wait for the first build (which is destined to fail) to complete
+before starting the second (hopefully fixed) build.
+ at end table
 
 @node PBListener,  , IRC Bot, Status Delivery
 @subsection PBListener
 
+ at cindex PBListener
 
 @code{buildbot.status.client.PBListener(port=int, user=str,
 passwd=str)}
@@ -2728,6 +2812,13 @@
 @node Resources, Index, Status Delivery, Top
 @chapter Resources
 
+The Buildbot's home page is at @uref{http://buildbot.sourceforge.net/}
+
+For configuration questions and general discussion, please use the
+ at code{buildbot-devel} mailing list. The subscription instructions and
+archives are available at
+ at uref{http://lists.sourceforge.net/lists/listinfo/buildbot-devel}
+
 
 @node Index,  , Resources, Top
 @unnumbered Index





More information about the Commits mailing list