[Buildbot-commits] buildbot/docs buildbot.texinfo,1.151,1.152

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ #305:stepinstances.diff]
Patch by Albert Hofkamp to use step instances universally in the
documentation.

Original author: dustin at zmanda.com
Date: 2008-06-26 03:35:41+00:00

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.151
retrieving revision 1.152
diff -u -d -r1.151 -r1.152
--- buildbot.texinfo	25 Jun 2008 23:52:31 -0000	1.151
+++ buildbot.texinfo	26 Jun 2008 03:52:19 -0000	1.152
@@ -4147,10 +4147,10 @@
 from buildbot.steps.shell import ShellCommand
 from buildbot.process.properties import WithProperties
 
-f.addStep(ShellCommand,
+f.addStep(ShellCommand(
           command=["tar", "czf",
                    WithProperties("build-%s.tar.gz", "revision"),
-                   "source"])
+                   "source"]))
 @end example
 
 If this BuildStep were used in a tree obtained from Subversion, it
@@ -4168,10 +4168,10 @@
 arguments:
 
 @example
-f.addStep(ShellCommand,
+f.addStep(ShellCommand(
           command=["tar", "czf",
                    WithProperties("build-%(revision)s.tar.gz"),
-                   "source"])
+                   "source"]))
 @end example
 
 Don't forget the extra ``s'' after the closing parenthesis! This is
@@ -4832,8 +4832,8 @@
 language setting, you might use
 
 @example
-f.addStep(ShellCommand, command=["make", "test"],
-          env=@{'LANG': 'fr_FR'@})
+f.addStep(ShellCommand(command=["make", "test"],
+                       env=@{'LANG': 'fr_FR'@}))
 @end example
 
 These variable settings will override any existing ones in the
@@ -4846,9 +4846,10 @@
 following:
 
 @example
-f.addStep(ShellCommand, command=["make", "test"],
-          env=@{'PYTHONPATH': ["/usr/local/lib/python2.3",
-                              "/home/buildbot/lib/python"] @})
+f.addStep(ShellCommand(
+              command=["make", "test"],
+              env=@{'PYTHONPATH': ["/usr/local/lib/python2.3",
+                                   "/home/buildbot/lib/python"] @}))
 @end example
 
 @item want_stdout
@@ -4878,8 +4879,9 @@
 the build runs, and any new text will be sent over to the buildmaster.
 
 @example
-f.addStep(ShellCommand, command=["make", "test"],
-          logfiles=@{"triallog": "_trial_temp/test.log"@})
+f.addStep(ShellCommand(
+              command=["make", "test"],
+              logfiles=@{"triallog": "_trial_temp/test.log"@}))
 @end example
 
 
@@ -4907,9 +4909,9 @@
 display.
 
 @example
-f.addStep(ShellCommand, command=["make", "test"],
-          description=["testing"],
-          descriptionDone=["tests"])
+f.addStep(ShellCommand(command=["make", "test"],
+                       description=["testing"],
+                       descriptionDone=["tests"]))
 @end example
 
 @end table
@@ -5091,7 +5093,7 @@
 from buildbot.steps.python import BuildEPYDoc
 
 ...
-f.addStep(BuildEPYDoc, command=["epydoc", "-o", "apiref", "source/mypkg"])
+f.addStep(BuildEPYDoc(command=["epydoc", "-o", "apiref", "source/mypkg"]))
 @end example
 
 
@@ -5118,7 +5120,7 @@
 from buildbot.steps.python import PyFlakes
 
 ...
-f.addStep(PyFlakes, command=["pyflakes", "src"])
+f.addStep(PyFlakes(command=["pyflakes", "src"]))
 @end example
 
 
@@ -5150,10 +5152,9 @@
 from buildbot.steps.shell import ShellCommand
 from buildbot.steps.transfer import FileUpload
 
-f.addStep(ShellCommand, command=["make", "docs"])
-f.addStep(FileUpload,
-          slavesrc="docs/reference.html",
-          masterdest="~/public_html/ref.html")
+f.addStep(ShellCommand(command=["make", "docs"]))
+f.addStep(FileUpload(slavesrc="docs/reference.html",
+                     masterdest="~/public_html/ref.html"))
 @end example
 
 The @code{masterdest=} argument will be passed to os.path.expanduser,
@@ -5173,10 +5174,9 @@
 from buildbot.steps.shell import ShellCommand
 from buildbot.steps.transfer import FileUpload
 
-f.addStep(FileDownload
-          mastersrc="~/todays_build_config.txt",
-          slavedest="build_config.txt")
-f.addStep(ShellCommand, command=["make", "config"])
+f.addStep(FileDownload(mastersrc="~/todays_build_config.txt",
+                       slavedest="build_config.txt"))
+f.addStep(ShellCommand(command=["make", "config"]))
 @end example
 
 Like @code{FileUpload}, the @code{mastersrc=} argument is interpreted
@@ -5219,9 +5219,9 @@
 
 @example
 from buildbot.steps.trigger import Trigger
-f.addStep(Trigger, schedulerNames=['build-prep'],
-                   waitForFinish=True,
-                   updateSourceStamp=True)
+f.addStep(Trigger(schedulerNames=['build-prep'],
+                  waitForFinish=True,
+                  updateSourceStamp=True))
 @end example
 
 The @code{schedulerNames=} argument lists the Triggerables