[Buildbot-commits] buildbot/docs buildbot.texinfo,1.49,1.50

[Brian Warner]

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

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

add docs on ChangeSources, including hg_buildbot.py

	* docs/buildbot.texinfo (Change Sources): mention hg_buildbot.py,
	give a quick mapping from VC system to possible ChangeSources


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -d -r1.49 -r1.50
--- buildbot.texinfo	23 May 2006 11:46:21 -0000	1.49
+++ buildbot.texinfo	23 May 2006 11:46:43 -0000	1.50
@@ -2212,6 +2212,90 @@
 provides a description of all available ChangeSource types and
 explains how to set up each of them.
 
+There are a variety of ChangeSources available, some of which are
+meant to be used in conjunction with other tools to deliver Change
+events from the VC repository to the buildmaster.
+
+ at itemize @bullet
+
+ at item CVSToys
+This ChangeSource opens a TCP connection from the buildmaster to a
+waiting FreshCVS daemon that lives on the repository machine, and
+subscribes to hear about Changes.
+
+ at item MaildirSource
+This one watches a local maildir-format inbox for email sent out by
+the repository when a change is made. When a message arrives, it is
+parsed to create the Change object. A variety of parsing functions are
+available to accomodate different email-sending tools.
+
+ at item PBChangeSource
+This ChangeSource listens on a local TCP socket for inbound
+connections from a separate tool. Usually, this tool would be run on
+the VC repository machine in a commit hook. It is expected to connect
+to the TCP socket and send a Change message over the network
+connection. The @command{buildbot sendchange} command is one example
+of a tool that knows how to send these messages, so you can write a
+commit script for your VC system that calls it to deliver the Change.
+There are other tools in the contrib/ directory that use the same
+protocol.
+
+ at end itemize
+
+As a quick guide, here is a list of VC systems and the ChangeSources
+that might be useful with them. All of these ChangeSources are in the
+ at code{buildbot.changes} module.
+
+ at table @code
+ at item CVS
+
+ at itemize @bullet
+ at item freshcvs.FreshCVSSource (connected via TCP to the freshcvs daemon)
+ at item mail.FCMaildirSource (watching for email sent by a freshcvs daemon)
+ at item mail.BonsaiMaildirSource (watching for email sent by Bonsai)
+ at item mail.SyncmailMaildirSource (watching for email sent by syncmail)
+ at item pb.PBChangeSource (listening for connections from @code{buildbot
+sendchange} run in a loginfo script)
+ at item pb.PBChangeSource (listening for connections from a long-running
+ at code{contrib/viewcvspoll.py} polling process which examines the ViewCVS
+database directly
+ at end itemize
+
+ at item SVN
+ at itemize @bullet
+ at item pb.PBChangeSource (listening for connections from
+ at code{contrib/svn_buildbot.py} run in a postcommit script)
+ at item pb.PBChangeSource (listening for connections from a long-running
+ at code{contrib/svn_watcher.py} or @code{contrib/svnpoller.py} polling
+process
+ at end itemize
+
+ at item Darcs
+ at itemize @bullet
+ at item pb.PBChangeSource (listening for connections from @code{buildbot
+sendchange} in a commit script
+ at end itemize
+
+ at item Mercurial
+ at itemize @bullet
+ at item pb.PBChangeSource (listening for connections from
+ at code{contrib/hg_buildbot.py} run in an 'incoming' hook)
+ at end itemize
+
+ at item Arch/Bazaar
+ at itemize @bullet
+ at item pb.PBChangeSource (listening for connections from
+ at code{contrib/arch_buildbot.py} run in a commit hook)
+ at end itemize
+
+ at end table
+
+All VC systems can be driven by a PBChangeSource and the
+ at code{buildbot sendchange} tool run from some form of commit script.
+If you write an email parsing function, they can also all be driven by
+a suitable @code{MaildirSource}.
+
+
 @menu
 * Choosing ChangeSources::      
 * CVSToys - PBService::         
@@ -2245,6 +2329,7 @@
 ignored by the changesource: it does not generate Changes for those
 files.
 
+
 @node CVSToys - PBService, CVSToys - mail notification, Choosing ChangeSources, Change Sources
 @subsection CVSToys - PBService