[Buildbot-commits] buildbot/docs buildbot.texinfo,1.81,1.82

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ svnpoller: add new ChangeSource, interim checkin]

Original author: warner at lothar.com
Date: 2006-10-01 17:18:18

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.81
retrieving revision 1.82
diff -u -d -r1.81 -r1.82
--- buildbot.texinfo	30 Sep 2006 21:12:08 -0000	1.81
+++ buildbot.texinfo	2 Oct 2006 00:13:12 -0000	1.82
@@ -153,6 +153,7 @@
 * PBChangeSource::              
 * P4Source::                    
 * BonsaiPoller::                
+* SvnSource::                   
 
 Build Process
 
@@ -2525,6 +2526,7 @@
 a suitable @code{MaildirSource}.
 
 
+* SvnSource::                    
 @menu
 * Choosing ChangeSources::      
 * CVSToys - PBService::         
@@ -2533,6 +2535,7 @@
 * PBChangeSource::              
 * P4Source::                    
 * BonsaiPoller::                
+* SvnSource::                   
 @end menu
 
 @node Choosing ChangeSources, CVSToys - PBService, Change Sources, Change Sources
@@ -2754,7 +2757,6 @@
 
 @end table
 
-
 @node P4Source, BonsaiPoller, PBChangeSource, Change Sources
 @subsection P4Source
 
@@ -2806,7 +2808,7 @@
 ))
 @end example
 
- at node BonsaiPoller,  , P4Source, Change Sources
+ at node BonsaiPoller, SvnSource, P4Source, Change Sources
 @subsection BonsaiPoller
 
 @csindex buildbot.changes.bonsaipoller.BonsaiPoller
@@ -2823,6 +2825,59 @@
 arguments it accepts.
 
 
+ at node SvnSource,  , BonsaiPoller, Change Sources
+ at subsection SvnSource
+
+ at csindex buildbot.changes.svnpoller.SvnSource
+
+The @code{SvnSource} periodically polls a
+ at uref{http://subversion.tigris.org/, Subversion} depot for changes, by
+running the @code{svn} command in a subshell. It accepts the following
+arguments:
+
+ at table @samp
+ at item @code{svnurl}
+The base URL path to watch. The repository this references could be
+local or remote, depending upon the URL's prefix.
+
+ at item @code{branch}
+The branch to watch. Defaults to '/trunk'.
+
+ at item @code{svnuser}
+The Subversion user.
+
+ at item @code{svnpasswd}
+The Subversion user's password.
+
+ at item @code{pollinterval}
+How often to poll, in seconds. Defaults to 600 (10 minutes).
+
+ at item @code{histmax}
+The maximum number of changes to inspect at a time. If more than this
+number occur since the last poll, older changes will be silently
+ignored. Larger values of histmax will cause more time and memory to
+be consumed on each poll attempt. @code{histmax} defaults to 100.
+ at end table
+
+ at heading Example
+
+This example watches the Subversion SVN tree itself for changes. It
+only pays attention to changes that appear on the trunk, and it labels
+all of its Change objects as being on branch=None (which is the
+convention within the buildbot for trunk changes).
+
+ at example
+from buildbot.changes.svnpoller import SvnSource
+ss = SvnSource('http://svn.collab.net/repos/svn/trunk')
+c['sources'].append(ss)
+ at end example
+
+This configuration uses the @code{SvnPORT}, @code{SvnUSER}, and
+ at code{SvnPASSWD} specified in the buildmaster's environment. It
+watches a project in which the branch name is simply the next path
+component, and the file is all path components after.
+
+
 @node Build Process, Status Delivery, Getting Source Code Changes, Top
 @chapter Build Process