[Buildbot-commits] buildbot/docs buildbot.texinfo,1.104,1.105

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ rename c['bots'] to c['slaves'], and use buildbot.slave.BuildSlave instances instead of tuples. Closes #63.]

Original author: warner at lothar.com
Date: 2007-07-27 09:11:01+00:00

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.104
retrieving revision 1.105
diff -u -d -r1.104 -r1.105
--- buildbot.texinfo	26 Jul 2007 19:38:45 -0000	1.104
+++ buildbot.texinfo	27 Jul 2007 10:13:56 -0000	1.105
@@ -2212,17 +2212,19 @@
 @node Buildslave Specifiers, Defining Builders, Setting the slaveport, Configuration
 @section Buildslave Specifiers
 
- at bcindex c['bots']
+ at bcindex c['slaves']
 
-The @code{c['bots']} key is a list of known buildslaves. Each
-buildslave is defined by a tuple of (slavename, slavepassword). These
-are the same two values that need to be provided to the buildslave
-administrator when they create the buildslave.
+The @code{c['slaves']} key is a list of known buildslaves. Each
+buildslave is defined by an instance of the BuildSlave class, created
+with two values: (slavename, slavepassword). These are the same two
+values that need to be provided to the buildslave administrator when
+they create the buildslave.
 
 @example
-c['bots'] = [('bot-solaris', 'solarispasswd'),
-             ('bot-bsd', 'bsdpasswd'),
-            ]
+from buildbot.slave import BuildSlave
+c['slaves'] = [BuildSlave('bot-solaris', 'solarispasswd'),
+               BuildSlave('bot-bsd', 'bsdpasswd'),
+              ]
 @end example
 
 The slavenames must be unique, of course. The password exists to
@@ -2234,6 +2236,11 @@
 will be rejected when they attempt to connect, and a message
 describing the problem will be put in the log file (see @ref{Logfiles}).
 
+Historical note: in buildbot-0.7.5 and earlier, the @code{c['bots']}
+key was used instead, and it took a list of (name, password) tuples.
+This key is accepted for backwards compatibility, but is deprecated as
+of 0.7.6 and will go away in some future release.
+
 
 @node Defining Builders, Defining Status Targets, Buildslave Specifiers, Configuration
 @section Defining Builders
@@ -2261,7 +2268,7 @@
 
 @item slavename
 This specifies which buildslave will be used by this Builder.
- at code{slavename} must appear in the @code{c['bots']} list. Each
+ at code{slavename} must appear in the @code{c['slaves']} list. Each
 buildslave can accomodate multiple Builders.
 
 @item slavenames