[Buildbot-commits] buildbot/docs buildbot.texinfo,1.9,1.10

[Brian Warner]

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

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

* docs/buildbot.texinfo: add some @cindex entries


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- buildbot.texinfo	19 Jul 2005 23:12:00 -0000	1.9
+++ buildbot.texinfo	20 Jul 2005 03:27:04 -0000	1.10
@@ -234,6 +234,8 @@
 @node History and Philosophy, System Architecture, Introduction, Introduction
 @section History and Philosophy
 
+ at cindex Philosophy of operation
+
 The Buildbot was inspired by a similar project built for a development
 team writing a cross-platform embedded system. The various components
 of the project were supposed to compile and run on several flavors of
@@ -441,6 +443,8 @@
 @node Installing the code, Creating a buildmaster, Requirements, Installation
 @section Installing the code
 
+ at cindex installation
+
 The Buildbot is installed using the standard python @code{distutils}
 module. After unpacking the tarball, the process is:
 
@@ -753,6 +757,8 @@
 @node Logfiles, Shutdown, Launching the daemons, Installation
 @section Logfiles
 
+ at cindex logfiles
+
 While a buildbot daemon runs, it emits text to a logfile, named
 @file{twistd.log}. A command like @code{tail -f twistd.log} is useful
 to watch the command output as it runs.
@@ -899,7 +905,7 @@
 @node Version Control Systems, Schedulers, Concepts, Concepts
 @section Version Control Systems
 
- at cindex CVS
+ at cindex Version Control
 
 These source trees come from a Version Control System of some kind.
 CVS and Subversion are two popular ones, but the Buildbot supports
@@ -1338,6 +1344,8 @@
 @node Users,  , Builder, Concepts
 @section Users
 
+ at cindex Users
+
 Buildbot has a somewhat limited awareness of @emph{users}. It assumes
 the world consists of a set of developers, each of whom can be
 described by a couple of simple attributes. These developers make
@@ -1477,6 +1485,8 @@
 @node Configuration, Getting Source Code Changes, Concepts, Top
 @chapter Configuration
 
+ at cindex Configuration
+
 The buildbot's behavior is defined by the ``config file'', which
 normally lives in the @file{master.cfg} file in the buildmaster's base
 directory (but this can be changed with an option to the
@@ -1603,15 +1613,18 @@
 c['buildbotURL'] = "http://localhost:8010/"
 @end example
 
+ at cindex 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']
 @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']
 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
@@ -1628,6 +1641,7 @@
 @node Listing Change Sources and Schedulers, Setting the slaveport, Defining the Project, Configuration
 @section Listing Change Sources and Schedulers
 
+ at cindex 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}.
@@ -1640,7 +1654,7 @@
 c['sources'] = [buildbot.changes.pb.PBChangeSource()]
 @end example
 
-
+ at cindex 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
@@ -1685,7 +1699,7 @@
 @node Build Dependencies,  , Listing Change Sources and Schedulers, Listing Change Sources and Schedulers
 @subsection Build Dependencies
 
- at cindex dependencies
+ at cindex Dependencies
 
 It is common to wind up with one kind of build which should only be
 performed if the same source code was successfully handled by some
@@ -1732,7 +1746,7 @@
 @node Setting the slaveport, Buildslave Specifiers, Listing Change Sources and Schedulers, Configuration
 @section Setting the slaveport
 
- at cindex slavePortnum
+ at cindex c['slavePortnum']
 
 The buildmaster will listen on a TCP port of your choosing for
 connections from buildslaves. It can also use this port for
@@ -1754,7 +1768,7 @@
 @node Buildslave Specifiers, Defining Builders, Setting the slaveport, Configuration
 @section Buildslave Specifiers
 
- at cindex bots
+ at cindex c['bots']
 
 The @code{c['bots']} key is a list of known buildslaves. Each
 buildslave is defined by a tuple of (slavename, slavepassword). These
@@ -1780,7 +1794,7 @@
 @node Defining Builders, Defining Status Targets, Buildslave Specifiers, Configuration
 @section Defining Builders
 
- at cindex builders
+ at cindex 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
@@ -1847,6 +1861,8 @@
 in the configuration's @code{status} list. To add status targets, you
 just append more objects to this list:
 
+ at cindex c['status']
+
 @example
 c['status'] = []
 
@@ -1872,6 +1888,7 @@
 @section Debug options
 
 
+ at cindex 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
@@ -1885,6 +1902,7 @@
 c['debugPassword'] = "debugpassword"
 @end example
 
+ at cindex c['manhole']
 If you set @code{c['manhole']} to an instance of the
 @code{buildbot.master.Manhole} class, you can telnet into the
 buildmaster and get an interactive Python shell, which may be useful