[Buildbot-commits] buildbot/docs buildbot.texinfo,1.64,1.65

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ docs: add another index, this one of all master.cfg keys]

Original author: warner at lothar.com
Date: 2006-08-11 05:04:29

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -d -r1.64 -r1.65
--- buildbot.texinfo	11 Aug 2006 07:31:03 -0000	1.64
+++ buildbot.texinfo	11 Aug 2006 07:31:37 -0000	1.65
@@ -7,6 +7,7 @@
 @defcodeindex bf
 @defcodeindex bs
 @defcodeindex st
+ at defcodeindex bc
 @c %**end of header
 
 @c these indices are for classes useful in a master.cfg config file
@@ -16,6 +17,8 @@
 @c @bsindex : Build Steps
 @c @stindex : Status Targets
 
+ at c @bcindex : keys that make up BuildmasterConfig
+
 @copying
 This is the BuildBot manual.
 
@@ -57,6 +60,7 @@
 * Resources::                   Getting help.
 * Developer's Appendix::        
 * Index of Useful Classes::     
+* Index of master.cfg keys::
 * Index::                       Complete index.
 
 @detailmenu
@@ -1898,18 +1902,18 @@
 c['buildbotURL'] = "http://localhost:8010/"
 @end example
 
- at cindex c['projectName']
+ at bcindex c['projectName']
 @code{projectName} is a short string will be used to describe the
 project that this buildbot is working on. For example, it is used as
 the title of the waterfall HTML page. 
 
- at cindex c['projectURL']
+ at bcindex c['projectURL']
 @code{projectURL} is a string that gives a URL for the project as a
 whole. HTML status displays will show @code{projectName} as a link to
 @code{projectURL}, to provide a link from buildbot HTML pages to your
 project's home page.
 
- at cindex c['buildbotURL']
+ at bcindex c['buildbotURL']
 The @code{buildbotURL} string should point to the location where the
 buildbot's internal web server (usually the @code{html.Waterfall}
 page) is visible. This typically uses the port number set when you
@@ -1926,7 +1930,7 @@
 @node Listing Change Sources and Schedulers, Setting the slaveport, Defining the Project, Configuration
 @section Listing Change Sources and Schedulers
 
- at cindex c['sources']
+ at bcindex c['sources']
 The @code{c['sources']} key is a list of ChangeSource
 instances at footnote{To be precise, it is a list of objects which all
 implement the @code{buildbot.interfaces.IChangeSource} Interface}.
@@ -1939,7 +1943,7 @@
 c['sources'] = [buildbot.changes.pb.PBChangeSource()]
 @end example
 
- at cindex c['schedulers']
+ at bcindex c['schedulers']
 @code{c['schedulers']} is a list of Scheduler instances, each of which
 causes builds to be started on a particular set of Builders. The two
 basic Scheduler classes you are likely to start with are
@@ -2111,7 +2115,7 @@
 @node Setting the slaveport, Buildslave Specifiers, Listing Change Sources and Schedulers, Configuration
 @section Setting the slaveport
 
- at cindex c['slavePortnum']
+ at bcindex c['slavePortnum']
 
 The buildmaster will listen on a TCP port of your choosing for
 connections from buildslaves. It can also use this port for
@@ -2148,7 +2152,7 @@
 @node Buildslave Specifiers, Defining Builders, Setting the slaveport, Configuration
 @section Buildslave Specifiers
 
- at cindex c['bots']
+ at bcindex c['bots']
 
 The @code{c['bots']} key is a list of known buildslaves. Each
 buildslave is defined by a tuple of (slavename, slavepassword). These
@@ -2174,7 +2178,7 @@
 @node Defining Builders, Defining Status Targets, Buildslave Specifiers, Configuration
 @section Defining Builders
 
- at cindex c['builders']
+ at bcindex c['builders']
 
 The @code{c['builders']} key is a list of dictionaries which specify
 the Builders. The Buildmaster runs a collection of Builders, each of
@@ -2259,7 +2263,7 @@
 in the configuration's @code{status} list. To add status targets, you
 just append more objects to this list:
 
- at cindex c['status']
+ at bcindex c['status']
 
 @example
 c['status'] = []
@@ -2286,7 +2290,7 @@
 @section Debug options
 
 
- at cindex c['debugPassword']
+ at bcindex c['debugPassword']
 If you set @code{c['debugPassword']}, then you can connect to the
 buildmaster with the diagnostic tool launched by @code{buildbot
 debugclient MASTER:PORT}. From this tool, you can reload the config
@@ -2300,7 +2304,7 @@
 c['debugPassword'] = "debugpassword"
 @end example
 
- at cindex c['manhole']
+ at bcindex c['manhole']
 If you set @code{c['manhole']} to an instance of one of the classes in
 @code{buildbot.manhole}, you can telnet or ssh into the buildmaster
 and get an interactive Python shell, which may be useful for debugging
@@ -5312,7 +5316,7 @@
 @code{.builders} dictionary.
 
 
- at node Index of Useful Classes, Index, Developer's Appendix, Top
+ at node Index of Useful Classes, Index of master.cfg keys, Developer's Appendix, Top
 @unnumbered Index of Useful Classes
 
 This is a list of all user-visible classes. There are the ones that
@@ -5344,11 +5348,30 @@
 @c TODO: undocumented targets
 @stindex buildbot.status.mail.MailNotifier
 
+ at node Index of master.cfg keys, Index, Index of Useful Classes, Top
+ at unnumbered Index of master.cfg keys
 
- at node Index,  , Index of Useful Classes, Top
+This is a list of all of the significant keys in master.cfg . Recall
+that master.cfg is effectively a small python program one
+responsibility: create a dictionary named @code{BuildmasterConfig}.
+The keys of this dictionary are listed here. The beginning of the
+master.cfg file typically starts with something like:
+
+ at example
+BuildmasterConfig = c = @{@}
+ at end example
+
+Therefore a config key of @code{sources} will usually appear in
+master.cfg as @code{c['sources']}.
+
+ at printindex bc
+
+
+ at node Index,  , Index of master.cfg keys, Top
 @unnumbered Index
 
 @printindex cp
 
+
 @bye