[Buildbot-commits] buildbot/docs buildbot.texinfo,1.62,1.63
Brian Warner
warner at users.sourceforge.net
Fri Aug 11 07:30:51 UTC 2006
Update of /cvsroot/buildbot/buildbot/docs
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv26010/docs
Modified Files:
buildbot.texinfo
Log Message:
[project @ reimplement 'useful classes' index with real texinfo indices]
Original author: warner at lothar.com
Date: 2006-08-11 03:59:59
Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -d -r1.62 -r1.63
--- buildbot.texinfo 6 Aug 2006 23:30:28 -0000 1.62
+++ buildbot.texinfo 11 Aug 2006 07:30:49 -0000 1.63
@@ -2,8 +2,20 @@
@c %**start of header
@setfilename buildbot.info
@settitle BuildBot Manual 0.7.3+
+ at defcodeindex cs
+ at defcodeindex sl
+ at defcodeindex bf
+ at defcodeindex bs
+ at defcodeindex st
@c %**end of header
+ at c these indices are for classes useful in a master.cfg config file
+ at c @csindex : Change Sources
+ at c @slindex : Schedulers and Locks
+ at c @bfindex : Build Factories
+ at c @bsindex : Build Steps
+ at c @stindex : Status Targets
+
@copying
This is the BuildBot manual.
@@ -1996,6 +2008,10 @@
@end menu
@node Scheduler Types, Build Dependencies, Listing Change Sources and Schedulers, Listing Change Sources and Schedulers
+ at slindex buildbot.scheduler.Scheduler
+ at slindex buildbot.scheduler.AnyBranchScheduler
+ at slindex buildbot.scheduler.Periodic
+ at slindex buildbot.scheduler.Nightly
@subsection Scheduler Types
Here is a brief catalog of the available Scheduler types. All these
@@ -2044,10 +2060,10 @@
@end table
@node Build Dependencies, , Scheduler Types, Listing Change Sources and Schedulers
- at subsection Build Dependencies
-
@cindex Dependent
@cindex Dependencies
+ at slindex buildbot.scheduler.Dependent
+ at subsection Build 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
@@ -2523,6 +2539,7 @@
@node CVSToys - PBService, CVSToys - mail notification, Choosing ChangeSources, Change Sources
+ at csindex buildbot.changes.freshcvs.FreshCVSSource
@subsection CVSToys - PBService
The @uref{http://purl.net/net/CVSToys, CVSToys} package provides a
@@ -2595,6 +2612,7 @@
@node CVSToys - mail notification, Other mail notification ChangeSources, CVSToys - PBService, Change Sources
+ at csindex buildbot.changes.mail.FCMaildirSource
@subsection CVSToys - mail notification
CVSToys also provides a @code{MailNotification} action which will send
@@ -2629,6 +2647,8 @@
directory name of the maildir root, and the prefix to strip.
@node Other mail notification ChangeSources, PBChangeSource, CVSToys - mail notification, Change Sources
+ at csindex buildbot.changes.mail.SyncmailMaildirSource
+ at csindex buildbot.changes.mail.BonsaiMaildirSource
@subsection Other mail notification ChangeSources
There are other types of maildir-watching ChangeSources, which only
@@ -2640,6 +2660,7 @@
@code{BonsaiMaildirSource} parses messages sent out by Bonsai.
@node PBChangeSource, P4Source, Other mail notification ChangeSources, Change Sources
+ at csindex buildbot.changes.pb.PBChangeSource
@subsection PBChangeSource
The last kind of ChangeSource actually listens on a TCP port for
@@ -2693,6 +2714,7 @@
@node P4Source, , PBChangeSource, Change Sources
+ at csindex buildbot.changes.p4poller.P4Source
@subsection P4Source
The @code{P4Source} periodically polls a @uref{http://www.perforce.com/,
@@ -2979,9 +3001,10 @@
@end menu
@node CVS, SVN, Source Checkout, Source Checkout
+ at cindex CVS Checkout
+ at bsindex buildbot.process.step.CVS
@subsubsection CVS
- at cindex CVS Checkout
The @code{CVS} build step performs a @uref{http://www.nongnu.org/cvs/,
CVS} checkout or update. It takes the following arguments:
@@ -3014,9 +3037,10 @@
@node SVN, Darcs, CVS, Source Checkout
+ at cindex SVN Checkout
+ at bsindex buildbot.process.step.SVN
@subsubsection SVN
- at cindex SVN Checkout
The @code{SVN} build step performs a
@uref{http://subversion.tigris.org, Subversion} checkout or update.
@@ -3148,9 +3172,10 @@
``features/newthing'' to get the svnurl for checkout.
@node Darcs, Mercurial, SVN, Source Checkout
+ at cindex Darcs Checkout
+ at bsindex buildbot.process.step.Darcs
@subsubsection Darcs
- at cindex Darcs Checkout
The @code{Darcs} build step performs a
@uref{http://abridgegame.org/darcs/, Darcs} checkout or update.
@@ -3190,9 +3215,10 @@
@end table
@node Mercurial, Arch, Darcs, Source Checkout
+ at cindex Mercurial Checkout
+ at bsindex buildbot.process.step.Mercurial
@subsubsection Mercurial
- at cindex Mercurial Checkout
The @code{Mercurial} build step performs a
@uref{http://selenic.com/mercurial, Mercurial} (aka ``hg'') checkout
@@ -3221,9 +3247,10 @@
@node Arch, Bazaar, Mercurial, Source Checkout
+ at cindex Arch Checkout
+ at bsindex buildbot.process.step.Arch
@subsubsection Arch
- at cindex Arch Checkout
The @code{Arch} build step performs an @uref{http://gnuarch.org/,
Arch} checkout or update using the @code{tla} client. It takes the
@@ -3248,9 +3275,10 @@
@end table
@node Bazaar, P4, Arch, Source Checkout
+ at cindex Bazaar Checkout
+ at bsindex buildbot.process.step.Bazaar
@subsubsection Bazaar
- at cindex Bazaar Checkout
@code{Bazaar} is an alternate implementation of the Arch VC system,
which uses a client named @code{baz}. The checkout semantics are just
@@ -3264,9 +3292,11 @@
@node P4, , Bazaar, Source Checkout
+ at cindex Perforce Update
+ at bsindex buildbot.process.step.P4
+ at c TODO @bsindex buildbot.process.step.P4Sync
@subsubsection P4
- at cindex Perforce Update
The @code{P4} build step creates a @uref{http://www.perforce.com/,
Perforce} client specification and performs an update.
@@ -3302,6 +3332,8 @@
@end table
@node ShellCommand, Simple ShellCommand Subclasses, Source Checkout, Build Steps
+ at bsindex buildbot.process.step.ShellCommand
+ at c TODO @bsindex buildbot.process.step.TreeSize
@subsection ShellCommand
This is a useful base class for just about everything you might want
@@ -3425,6 +3457,7 @@
@end menu
@node Configure, Compile, Simple ShellCommand Subclasses, Simple ShellCommand Subclasses
+ at bsindex buildbot.process.step.Configure
@subsubsection Configure
This is intended to handle the @code{./configure} step from
@@ -3433,6 +3466,7 @@
but you can change this by providing a @code{command=} parameter.
@node Compile, Test, Configure, Simple ShellCommand Subclasses
+ at bsindex buildbot.process.step.Compile
@subsubsection Compile
This is meant to handle compiling or building a project written in C. The
@@ -3442,6 +3476,7 @@
created).
@node Test, Build Properties, Compile, Simple ShellCommand Subclasses
+ at bsindex buildbot.process.step.Test
@subsubsection Test
This is meant to handle unit tests. The default command is @code{make
@@ -3721,9 +3756,10 @@
@node Interlocks, Build Factories, Build Steps, Build Process
- at section Interlocks
-
@cindex locks
+ at slindex buildbot.locks.MasterLock
+ at slindex buildbot.locks.SlaveLock
+ at section Interlocks
For various reasons, you may want to prevent certain Steps (or perhaps
entire Builds) from running simultaneously. Limited CPU speed or
@@ -3933,6 +3969,10 @@
@node BuildFactory, Process-Specific build factories, BuildStep Objects, Build Factories
+ at bfindex buildbot.process.factory.BuildFactory
+ at bfindex buildbot.process.factory.BasicBuildFactory
+ at c TODO: what is BasicSVN anyway?
+ at bfindex buildbot.process.factory.BasicSVN
@subsection BuildFactory
The default @code{BuildFactory}, provided in the
@@ -4032,6 +4072,7 @@
@node Quick builds, , BuildFactory Attributes, BuildFactory
+ at bfindex buildbot.process.factory.QuickBuildFactory
@subsubsection Quick builds
The difference between a ``full build'' and a ``quick build'' is that
@@ -4063,6 +4104,7 @@
@end menu
@node GNUAutoconf, CPAN, Process-Specific build factories, Process-Specific build factories
+ at bfindex buildbot.process.factory.GNUAutoconf
@subsubsection GNUAutoconf
@uref{http://www.gnu.org/software/autoconf/, GNU Autoconf} is a
@@ -4139,6 +4181,7 @@
@node CPAN, Python distutils, GNUAutoconf, Process-Specific build factories
+ at bfindex buildbot.process.factory.CPAN
@subsubsection CPAN
Most Perl modules available from the @uref{http://www.cpan.org/, CPAN}
@@ -4172,6 +4215,7 @@
@node Python distutils, Python/Twisted/trial projects, CPAN, Process-Specific build factories
+ at bfindex buildbot.process.factory.Distutils
@subsubsection Python distutils
Most Python modules use the @code{distutils} package to provide
@@ -4212,6 +4256,13 @@
@node Python/Twisted/trial projects, , Python distutils, Process-Specific build factories
+ at bfindex buildbot.process.factory.Trial
+ at 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
@subsubsection Python/Twisted/trial projects
Twisted provides a unit test tool named @code{trial} which provides a
@@ -4397,10 +4448,16 @@
* Writing New Status Plugins::
@end menu
+ at c @node Email Delivery, , Status Delivery, Status Delivery
+ at c @subsection Email Delivery
+
+ at c DOCUMENT THIS
+
@node HTML Waterfall, IRC Bot, Status Delivery, Status Delivery
+ at cindex Waterfall
+ at stindex buildbot.status.html.Waterfall
@section HTML Waterfall
- at cindex Waterfall
@example
from buildbot.status import html
@@ -4479,9 +4536,10 @@
@node IRC Bot, PBListener, HTML Waterfall, Status Delivery
+ at cindex IRC
+ at stindex buildbot.status.words.IRC
@section IRC Bot
- at cindex IRC
The @code{buildbot.status.words.IRC} status target creates an IRC bot
which will attach to certain channels and be available for status
@@ -4549,9 +4607,10 @@
@end table
@node PBListener, Writing New Status Plugins, IRC Bot, Status Delivery
+ at cindex PBListener
+ at stindex buildbot.status.client.PBListener
@section PBListener
- at cindex PBListener
@example
import buildbot.status.client
@@ -4740,6 +4799,9 @@
@heading TryScheduler
+ at slindex buildbot.scheduler.Try_Jobdir
+ at slindex buildbot.scheduler.Try_Userpass
+
The buildmaster must have a @code{scheduler.Try} instance in
the config file's @code{c['schedulers']} list. This lets the
administrator control who may initiate these ``trial'' builds, which
@@ -5257,130 +5319,30 @@
Classes that are not listed here are generally internal things that
admins are unlikely to have much use for.
- at heading Change Sources
-
- at table @code
- at item buildbot.changes.freshcvs.FreshCVSSource
- at ref{CVSToys - PBService}
-
- at item buildbot.changes.mail.FCMaildirSource
- at ref{CVSToys - mail notification}
-
- at item buildbot.changes.mail.SyncmailMaildirSource
- at ref{Other mail notification ChangeSources}
-
- at item buildbot.changes.mail.BonsaiMaildirSource
- at ref{Other mail notification ChangeSources}
-
- at item buildbot.changes.p4poller.P4Source
- at ref{P4Source}
-
- at item buildbot.changes.pb.PBChangeSource
- at ref{PBChangeSource}
-
- at end table
+ at heading Change Sources
+ at printindex cs
@heading Schedulers and Locks
- at table @code
- at item buildbot.scheduler.Scheduler
- at ref{Scheduler Types}
-
- at item buildbot.scheduler.AnyBranchScheduler
- at ref{Scheduler Types}
-
- at item buildbot.scheduler.Dependent
- at ref{Build Dependencies}
-
- at item buildbot.scheduler.Periodic
- at ref{Scheduler Types}
-
- at item buildbot.scheduler.Nightly
- at ref{Scheduler Types}
-
- at item buildbot.scheduler.Try_Jobdir
- at ref{try}
- at item buildbot.scheduler.Try_Userpass
- at ref{try}
-
- at item buildbot.locks.MasterLock
- at ref{Interlocks}
-
- at item buildbot.locks.SlaveLock
- at ref{Interlocks}
-
- at end table
+ at printindex sl
@heading Build Factories
- at table @code
- at item buildbot.process.factory.BuildFactory
- at ref{BuildFactory}
- at item buildbot.process.factory.GNUAutoconf
- at ref{GNUAutoconf}
- at item buildbot.process.factory.CPAN
- at ref{CPAN}
- at item buildbot.process.factory.Distutils
- at ref{Python distutils}
- at item buildbot.process.factory.Trial
- at ref{Python/Twisted/trial projects}
- at item buildbot.process.factory.BasicBuildFactory
- at item buildbot.process.factory.QuickBuildFactory
- at item buildbot.process.factory.BasicSVN
- at end table
+ at printindex bf
@heading Build Steps
- at table @code
- at item buildbot.process.step.ShellCommand
- at ref{ShellCommand}
- at item buildbot.process.step.TreeSize
- at item buildbot.process.step.CVS
- at c TODO: this CVS link is broken, it goes to a CVSToys page for some reason
- at ref{CVS}
- at item buildbot.process.step.SVN
- at ref{SVN}
- at item buildbot.process.step.Darcs
- at ref{Darcs}
- at item buildbot.process.step.Git
- at item buildbot.process.step.Arch
- at ref{Arch}
- at item buildbot.process.step.Bazaar
- at ref{Bazaar}
- at item buildbot.process.step.Mercurial
- at ref{Mercurial}
- at item buildbot.process.step.P4
- at c TODO: this P4 like goes to P4Source by mistake
- at ref{P4}
- at item buildbot.process.step.P4Sync
- at item buildbot.process.step.Configure
- at ref{Configure}
- at item buildbot.process.step.Compile
- at ref{Compile}
- at item buildbot.process.step.Test
- at ref{Test}
- at item buildbot.process.step_twisted.HLint
- at item buildbot.process.step_twisted.Trial
- at item buildbot.process.step_twisted.ProcessDocs
- at item buildbot.process.step_twisted.BuildDebs
- at item buildbot.process.step_twisted.RemovePYCs
- at item buildbot.process.maxq.MaxQ
- at end table
-
-
- at heading Status Targets
- at table @code
+ at printindex bs
- at item buildbot.status.html.Waterfall
- at ref{HTML Waterfall}
+ at c undocumented steps
+ at bsindex buildbot.process.step.Git
+ at bsindex buildbot.process.maxq.MaxQ
- at item buildbot.status.mail.MailNotifier
- at item buildbot.status.words.IRC
- at ref{IRC Bot}
+ at heading Status Targets
+ at printindex st
- at item buildbot.status.client.PBListener
- at ref{PBListener}
+ at c TODO: undocumented targets
+ at stindex buildbot.status.mail.MailNotifier
- at end table
@node Index, , Index of Useful Classes, Top
@unnumbered Index
More information about the Commits
mailing list