[Buildbot-commits] buildbot/docs buildbot.texinfo,1.74,1.75

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ update docs, factories, and tests to use new buildbot/steps/* definitions]

Original author: warner at lothar.com
Date: 2006-09-08 21:25:42

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.74
retrieving revision 1.75
diff -u -d -r1.74 -r1.75
--- buildbot.texinfo	24 Aug 2006 10:05:20 -0000	1.74
+++ buildbot.texinfo	15 Sep 2006 14:47:42 -0000	1.75
@@ -1400,7 +1400,7 @@
 @code{filename.endswith(".c")} to only run a build if a C file were
 checked in. Certain BuildSteps can also use the list of changed files
 to run a more targeted series of tests, e.g. the
- at code{step_twisted.Trial} step can run just the unit tests that
+ at code{python_twisted.Trial} step can run just the unit tests that
 provide coverage for the modified .py files instead of running the
 full test suite.
 
@@ -2841,12 +2841,13 @@
 @code{BuildFactory}'s @code{addStep} method:
 
 @example
-from buildbot.process import step, factory
+from buildbot.steps import source, shell
+from buildbot.process import factory
 
 f = factory.BuildFactory()
-f.addStep(step.SVN, svnurl="http://svn.example.org/Trunk/")
-f.addStep(step.ShellCommand, command=["make", "all"])
-f.addStep(step.ShellCommand, command=["make", "test"])
+f.addStep(source.SVN, svnurl="http://svn.example.org/Trunk/")
+f.addStep(shell.ShellCommand, command=["make", "all"])
+f.addStep(shell.ShellCommand, command=["make", "test"])
 @end example
 
 The rest of this section lists all the standard BuildStep objects
@@ -3034,7 +3035,7 @@
 @subsubsection CVS
 
 @cindex CVS Checkout
- at bsindex buildbot.process.step.CVS
+ at bsindex buildbot.steps.source.CVS
 
 
 The @code{CVS} build step performs a @uref{http://www.nongnu.org/cvs/,
@@ -3071,7 +3072,7 @@
 @subsubsection SVN
 
 @cindex SVN Checkout
- at bsindex buildbot.process.step.SVN
+ at bsindex buildbot.steps.source.SVN
 
 
 The @code{SVN} build step performs a
@@ -3173,7 +3174,8 @@
 @example
 from buildbot.changes.pb import PBChangeSource
 from buildbot.scheduler import AnyBranchScheduler
-from buildbot.process import step, factory
+from buildbot.process import source, factory
+from buildbot.steps import source, shell
 
 c['sources'] = [PBChangeSource()]
 s1 = AnyBranchScheduler('main',
@@ -3182,11 +3184,11 @@
 c['schedulers'] = [s1]
 
 f = factory.BuildFactory()
-f.addStep(step.SVN, mode='update',
+f.addStep(source.SVN, mode='update',
           baseURL='svn://svn.example.org/MyProject/',
           defaultBranch='trunk')
-f.addStep(step.Compile, command="make all")
-f.addStep(step.Test, command="make test")
+f.addStep(shell.Compile, command="make all")
+f.addStep(shell.Test, command="make test")
 
 c['builders'] = [
   @{'name':'test-i386', 'slavename':'bot-i386', 'builddir':'test-i386',
@@ -3208,7 +3210,7 @@
 @subsubsection Darcs
 
 @cindex Darcs Checkout
- at bsindex buildbot.process.step.Darcs
+ at bsindex buildbot.steps.source.Darcs
 
 
 The @code{Darcs} build step performs a
@@ -3252,7 +3254,7 @@
 @subsubsection Mercurial
 
 @cindex Mercurial Checkout
- at bsindex buildbot.process.step.Mercurial
+ at bsindex buildbot.steps.source.Mercurial
 
 
 The @code{Mercurial} build step performs a
@@ -3285,7 +3287,7 @@
 @subsubsection Arch
 
 @cindex Arch Checkout
- at bsindex buildbot.process.step.Arch
+ at bsindex buildbot.steps.source.Arch
 
 
 The @code{Arch} build step performs an @uref{http://gnuarch.org/,
@@ -3314,7 +3316,7 @@
 @subsubsection Bazaar
 
 @cindex Bazaar Checkout
- at bsindex buildbot.process.step.Bazaar
+ at bsindex buildbot.steps.source.Bazaar
 
 
 @code{Bazaar} is an alternate implementation of the Arch VC system,
@@ -3332,8 +3334,8 @@
 @subsubsection P4
 
 @cindex Perforce Update
- at bsindex buildbot.process.step.P4
- at c TODO @bsindex buildbot.process.step.P4Sync
+ at bsindex buildbot.steps.source.P4
+ at c TODO @bsindex buildbot.steps.source.P4Sync
 
 
 The @code{P4} build step creates a @uref{http://www.perforce.com/,
@@ -3372,8 +3374,8 @@
 @node ShellCommand, Simple ShellCommand Subclasses, Source Checkout, Build Steps
 @subsection ShellCommand
 
- at bsindex buildbot.process.step.ShellCommand
- at c TODO @bsindex buildbot.process.step.TreeSize
+ at bsindex buildbot.steps.shell.ShellCommand
+ at c TODO @bsindex buildbot.steps.shell.TreeSize
 
 This is a useful base class for just about everything you might want
 to do during a build (except for the initial source checkout). It runs
@@ -3514,7 +3516,7 @@
 @node Configure, Compile, Simple ShellCommand Subclasses, Simple ShellCommand Subclasses
 @subsubsection Configure
 
- at bsindex buildbot.process.step.Configure
+ at bsindex buildbot.steps.shell.Configure
 
 This is intended to handle the @code{./configure} step from
 autoconf-style projects, or the @code{perl Makefile.PL} step from perl
@@ -3524,7 +3526,7 @@
 @node Compile, Test, Configure, Simple ShellCommand Subclasses
 @subsubsection Compile
 
- at bsindex buildbot.process.step.Compile
+ at bsindex buildbot.steps.shell.Compile
 
 This is meant to handle compiling or building a project written in C. The
 default command is @code{make all}. When the compile is finished, the
@@ -3535,7 +3537,7 @@
 @node Test, Build Properties, Compile, Simple ShellCommand Subclasses
 @subsubsection Test
 
- at bsindex buildbot.process.step.Test
+ at bsindex buildbot.steps.shell.Test
 
 This is meant to handle unit tests. The default command is @code{make
 test}, and the @code{warnOnFailure} flag is set.
@@ -3571,12 +3573,12 @@
 class instances.} object. For example:
 
 @example
-class MakeTarball(step.ShellCommand):
+class MakeTarball(ShellCommand):
     def start(self):
         self.setCommand(["tar", "czf",
                          "build-%s.tar.gz" % self.getProperty("revision"),
                          "source"])
-        step.ShellCommand.start(self)
+        ShellCommand.start(self)
 @end example
 
 @cindex WithProperties
@@ -3587,7 +3589,7 @@
 generated shell command.
 
 @example
-from buildbot.process.step import ShellCommand, WithProperties
+from buildbot.steps.shell import ShellCommand, WithProperties
 
 f.addStep(ShellCommand,
           command=["tar", "czf",
@@ -4050,13 +4052,14 @@
 
 @example
 from buildbot import locks
-from buildbot.process import step, factory
+from buildbot.steps import source, shell
+from buildbot.process import factory
 
 db_lock = locks.MasterLock("database")
 f = factory.BuildFactory()
-f.addStep(step.SVN, svnurl="http://example.org/svn/Trunk")
-f.addStep(step.ShellCommand, command="make all")
-f.addStep(step.ShellCommand, command="make test", locks=[db_lock])
+f.addStep(source.SVN, svnurl="http://example.org/svn/Trunk")
+f.addStep(shell.ShellCommand, command="make all")
+f.addStep(shell.ShellCommand, command="make test", locks=[db_lock])
 b1 = @{'name': 'full1', 'slavename': 'bot-1', builddir='f1', 'factory': f@}
 b2 = @{'name': 'full2', 'slavename': 'bot-2', builddir='f2', 'factory': f@}
 b3 = @{'name': 'full3', 'slavename': 'bot-3', builddir='f3', 'factory': f@}
@@ -4078,10 +4081,11 @@
 
 @example
 from buildbot import locks
-from buildbot.process import s, step, factory
+from buildbot.steps import source
+from buildbot.process import s, factory
 
 slow_lock = locks.SlaveLock("cpu", maxCount=2)
-source = s(step.SVN, svnurl="http://example.org/svn/Trunk")
+source = s(source.SVN, svnurl="http://example.org/svn/Trunk")
 f22 = factory.Trial(source, trialpython=["python2.2"])
 f23 = factory.Trial(source, trialpython=["python2.3"])
 f24 = factory.Trial(source, trialpython=["python2.4"])
@@ -4106,17 +4110,18 @@
 
 @example
 from buildbot import locks
-from buildbot.process import step, factory
+from buildbot.steps import source, shell
+from buildbot.process import factory
 
 db_lock = locks.MasterLock("database")
 slavecounts = @{"bot-slow": 1, "bot-fast": 100@}
 cpu_lock = locks.SlaveLock("cpu", maxCountForSlave=slavecounts)
 f = factory.BuildFactory()
-f.addStep(step.SVN, svnurl="http://example.org/svn/Trunk")
-f.addStep(step.ShellCommand, command="make all", locks=[cpu_lock])
-f.addStep(step.ShellCommand, command="make test", locks=[cpu_lock])
-f.addStep(step.ShellCommand, command="make db-test",
-                             locks=[db_lock, cpu_lock])
+f.addStep(source.SVN, svnurl="http://example.org/svn/Trunk")
+f.addStep(shell.ShellCommand, command="make all", locks=[cpu_lock])
+f.addStep(shell.ShellCommand, command="make test", locks=[cpu_lock])
+f.addStep(shell.ShellCommand, command="make db-test",
+                              locks=[db_lock, cpu_lock])
 
 b1 = @{'name': 'full1', 'slavename': 'bot-slow', builddir='full1',
       'factory': f@}
@@ -4232,11 +4237,12 @@
 as follows:
 
 @example
-from buildbot.process import step, factory
+from buildbot.steps import source, shell
+from buildbot.process import factory
 
 f = factory.BuildFactory()
-f.addStep(step.CVS, cvsroot=CVSROOT, cvsmodule="project", mode="update")
-f.addStep(step.Compile, command=["make", "build"])
+f.addStep(source.CVS, cvsroot=CVSROOT, cvsmodule="project", mode="update")
+f.addStep(shell.Compile, command=["make", "build"])
 @end example
 
 It is also possible to pass a list of step specifications into the
@@ -4246,13 +4252,15 @@
 a convenience function named @code{s} is available:
 
 @example
-from buildbot.process import step, factory
+from buildbot.steps import source, shell
+from buildbot.process import factory
 from buildbot.factory import s
 # s is a convenience function, defined with:
 # def s(steptype, **kwargs): return (steptype, kwargs)
 
-all_steps = [s(step.CVS, cvsroot=CVSROOT, cvsmodule="project", mode="update"),
-             s(step.Compile, command=["make", "build"]),
+all_steps = [s(source.CVS, cvsroot=CVSROOT, cvsmodule="project",
+               mode="update"),
+             s(shell.Compile, command=["make", "build"]),
             ]
 f = factory.BuildFactory(all_steps)
 @end example
@@ -4525,11 +4533,11 @@
 
 @bfindex buildbot.process.factory.Trial
 @c TODO: document these steps better
- at bsindex buildbot.process.step_twisted.HLint
- at bsindex buildbot.process.step_twisted.Trial
- at bsindex buildbot.process.step_twisted.ProcessDocs
- at bsindex buildbot.process.step_twisted.BuildDebs
- at bsindex buildbot.process.step_twisted.RemovePYCs
+ at bsindex buildbot.steps.python_twisted.HLint
+ at bsindex buildbot.steps.python_twisted.Trial
+ at bsindex buildbot.steps.python_twisted.ProcessDocs
+ at bsindex buildbot.steps.python_twisted.BuildDebs
+ at bsindex buildbot.steps.python_twisted.RemovePYCs
 
 Twisted provides a unit test tool named @code{trial} which provides a
 few improvements over Python's built-in @code{unittest} module. Many
@@ -5602,8 +5610,8 @@
 @printindex bs
 
 @c undocumented steps
- at bsindex buildbot.process.step.Git
- at bsindex buildbot.process.maxq.MaxQ
+ at bsindex buildbot.steps.source.Git
+ at bsindex buildbot.steps.maxq.MaxQ
 
 
 @heading Status Targets