[Buildbot-commits] buildbot/docs buildbot.texinfo,1.29,1.30

[Brian Warner]

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

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

add cron-style 'scheduler.Nightly', thanks to Dobes Vandermeer

	* docs/buildbot.texinfo (Scheduler Types): give a few hints about
	what Schedulers are available

	* buildbot/scheduler.py (Nightly): add new Scheduler based upon
	work by Dobes Vandermeer and hacked mercilessly by me. This offers
	'cron'-style build scheduling at certain times of day, week,
	month, or year.
	* buildbot/test/test_scheduler.py (Scheduling.testNightly): test it


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -r1.29 -r1.30
--- buildbot.texinfo	26 Oct 2005 20:22:50 -0000	1.29
+++ buildbot.texinfo	26 Nov 2005 02:09:24 -0000	1.30
@@ -110,6 +110,7 @@
 
 Listing Change Sources and Schedulers
 
+* Scheduler Types::             
 * Build Dependencies::          
 
 Getting Source Code Changes
@@ -1733,10 +1734,59 @@
 depending upon when it was first activated).
 
 @menu
+* Scheduler Types::             
 * Build Dependencies::          
 @end menu
 
- at node Build Dependencies,  , Listing Change Sources and Schedulers, Listing Change Sources and Schedulers
+ at node Scheduler Types, Build Dependencies, Listing Change Sources and Schedulers, Listing Change Sources and Schedulers
+ at subsection Scheduler Types
+
+Here is a brief catalog of the available Scheduler types. All these
+Schedulers are classes in @code{buildbot.scheduler}, and the
+docstrings there are the best source of documentation on the arguments
+taken by each one.
+
+ at table @code
+ at item Scheduler
+This is the default Scheduler class. It follows exactly one branch,
+and starts a configurable tree-stable-timer after each change on that
+branch. When the timer expires, it starts a build on some set of
+Builders. The Scheduler accepts a @code{fileIsImportant} function
+which can be used to ignore some Changes if they do not affect any
+``important'' files.
+
+ at item AnyBranchScheduler
+This scheduler uses a tree-stable-timer like the default one, but
+follows multiple branches at once. Each branch gets a separate timer.
+
+ at item Dependent
+This scheduler watches an ``upstream'' Builder. When that Builder
+successfully builds a particular set of Changes, it triggers builds of
+the same code on a configured set of ``downstream'' builders. The next
+section (@pxref{Build Dependencies}) describes this scheduler in more
+detail.
+
+ at item Periodic
+This simple scheduler just triggers a build every N seconds.
+
+ at item Nightly
+This is highly configurable periodic build scheduler, which triggers a
+build at particular times of day, week, month, or year. The
+configuration syntax is very similar to the well-known @code{crontab}
+format, in which you provide values for minute, hour, day, and month
+(some of which can be wildcards), and a build is triggered whenever
+the current time matches the given constraints. This can run a build
+every night, every morning, every weekend, alternate Thursdays, on
+your boss's birthday, etc.
+
+ at item Try_Jobdir / Try_Userpass
+This scheduler allows developers to use the @code{buildbot try}
+command to trigger builds of code they have not yet committed. See
+ at ref{try} for complete details.
+
+ at end table
+
+ at node Build Dependencies,  , Scheduler Types, Listing Change Sources and Schedulers
 @subsection Build Dependencies
 
 @cindex Dependencies