[Buildbot-commits] buildbot/docs buildbot.texinfo,1.65,1.66
Brian Warner
warner at users.sourceforge.net
Fri Aug 11 07:31:51 UTC 2006
Update of /cvsroot/buildbot/buildbot/docs
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv26471/docs
Modified Files:
buildbot.texinfo
Log Message:
[project @ docs: fix index tags to avoid confusing texinfo]
Original author: warner at lothar.com
Date: 2006-08-11 07:29:10
Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -d -r1.65 -r1.66
--- buildbot.texinfo 11 Aug 2006 07:31:37 -0000 1.65
+++ buildbot.texinfo 11 Aug 2006 07:31:49 -0000 1.66
@@ -60,7 +60,7 @@
* Resources:: Getting help.
* Developer's Appendix::
* Index of Useful Classes::
-* Index of master.cfg keys::
+* Index of master.cfg keys::
* Index:: Complete index.
@detailmenu
@@ -194,6 +194,11 @@
* BuildFactory::
* Process-Specific build factories::
+BuildStep Objects
+
+* BuildFactory Attributes::
+* Quick builds::
+
BuildFactory
* BuildFactory Attributes::
@@ -2013,11 +2018,12 @@
@end menu
@node Scheduler Types, Build Dependencies, Listing Change Sources and Schedulers, Listing Change Sources and Schedulers
+ at subsection Scheduler Types
+
@slindex buildbot.scheduler.Scheduler
@slindex buildbot.scheduler.AnyBranchScheduler
@slindex buildbot.scheduler.Periodic
@slindex buildbot.scheduler.Nightly
- at subsection Scheduler Types
Here is a brief catalog of the available Scheduler types. All these
Schedulers are classes in @code{buildbot.scheduler}, and the
@@ -2065,10 +2071,11 @@
@end table
@node Build Dependencies, , Scheduler Types, Listing Change Sources and Schedulers
+ at subsection Build Dependencies
+
@cindex Dependent
@cindex Dependencies
@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
@@ -2544,9 +2551,10 @@
@node CVSToys - PBService, CVSToys - mail notification, Choosing ChangeSources, Change Sources
- at csindex buildbot.changes.freshcvs.FreshCVSSource
@subsection CVSToys - PBService
+ at csindex buildbot.changes.freshcvs.FreshCVSSource
+
The @uref{http://purl.net/net/CVSToys, CVSToys} package provides a
server which runs on the machine that hosts the CVS repository it
watches. It has a variety of ways to distribute commit notifications,
@@ -2617,9 +2625,10 @@
@node CVSToys - mail notification, Other mail notification ChangeSources, CVSToys - PBService, Change Sources
- at csindex buildbot.changes.mail.FCMaildirSource
@subsection CVSToys - mail notification
+ at csindex buildbot.changes.mail.FCMaildirSource
+
CVSToys also provides a @code{MailNotification} action which will send
email to a list of recipients for each commit. This tends to work
better than using @code{/bin/mail} from within the CVSROOT/loginfo
@@ -2652,9 +2661,10 @@
directory name of the maildir root, and the prefix to strip.
@node Other mail notification ChangeSources, PBChangeSource, CVSToys - mail notification, Change Sources
+ at subsection Other mail notification ChangeSources
+
@csindex buildbot.changes.mail.SyncmailMaildirSource
@csindex buildbot.changes.mail.BonsaiMaildirSource
- at subsection Other mail notification ChangeSources
There are other types of maildir-watching ChangeSources, which only
differ in the function used to parse the message body.
@@ -2665,9 +2675,10 @@
@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
+ at csindex buildbot.changes.pb.PBChangeSource
+
The last kind of ChangeSource actually listens on a TCP port for
clients to connect and push change notices @emph{into} the
Buildmaster. This is used by the built-in @code{buildbot sendchange}
@@ -2719,9 +2730,10 @@
@node P4Source, , PBChangeSource, Change Sources
- at csindex buildbot.changes.p4poller.P4Source
@subsection P4Source
+ at csindex buildbot.changes.p4poller.P4Source
+
The @code{P4Source} periodically polls a @uref{http://www.perforce.com/,
Perforce} depot for changes. It accepts the following arguments:
@@ -3006,9 +3018,10 @@
@end menu
@node CVS, SVN, Source Checkout, Source Checkout
+ at subsubsection CVS
+
@cindex CVS Checkout
@bsindex buildbot.process.step.CVS
- at subsubsection CVS
The @code{CVS} build step performs a @uref{http://www.nongnu.org/cvs/,
@@ -3042,9 +3055,10 @@
@node SVN, Darcs, CVS, Source Checkout
+ at subsubsection SVN
+
@cindex SVN Checkout
@bsindex buildbot.process.step.SVN
- at subsubsection SVN
The @code{SVN} build step performs a
@@ -3177,9 +3191,10 @@
``features/newthing'' to get the svnurl for checkout.
@node Darcs, Mercurial, SVN, Source Checkout
+ at subsubsection Darcs
+
@cindex Darcs Checkout
@bsindex buildbot.process.step.Darcs
- at subsubsection Darcs
The @code{Darcs} build step performs a
@@ -3220,9 +3235,10 @@
@end table
@node Mercurial, Arch, Darcs, Source Checkout
+ at subsubsection Mercurial
+
@cindex Mercurial Checkout
@bsindex buildbot.process.step.Mercurial
- at subsubsection Mercurial
The @code{Mercurial} build step performs a
@@ -3252,9 +3268,10 @@
@node Arch, Bazaar, Mercurial, Source Checkout
+ at subsubsection Arch
+
@cindex Arch Checkout
@bsindex buildbot.process.step.Arch
- at subsubsection Arch
The @code{Arch} build step performs an @uref{http://gnuarch.org/,
@@ -3280,9 +3297,10 @@
@end table
@node Bazaar, P4, Arch, Source Checkout
+ at subsubsection Bazaar
+
@cindex Bazaar Checkout
@bsindex buildbot.process.step.Bazaar
- at subsubsection Bazaar
@code{Bazaar} is an alternate implementation of the Arch VC system,
@@ -3297,10 +3315,11 @@
@node P4, , Bazaar, Source Checkout
+ at subsubsection P4
+
@cindex Perforce Update
@bsindex buildbot.process.step.P4
@c TODO @bsindex buildbot.process.step.P4Sync
- at subsubsection P4
The @code{P4} build step creates a @uref{http://www.perforce.com/,
@@ -3337,9 +3356,10 @@
@end table
@node ShellCommand, Simple ShellCommand Subclasses, Source Checkout, Build Steps
+ at subsection ShellCommand
+
@bsindex buildbot.process.step.ShellCommand
@c TODO @bsindex buildbot.process.step.TreeSize
- at subsection ShellCommand
This is a useful base class for just about everything you might want
to do during a build (except for the initial source checkout). It runs
@@ -3462,18 +3482,20 @@
@end menu
@node Configure, Compile, Simple ShellCommand Subclasses, Simple ShellCommand Subclasses
- at bsindex buildbot.process.step.Configure
@subsubsection Configure
+ at bsindex buildbot.process.step.Configure
+
This is intended to handle the @code{./configure} step from
autoconf-style projects, or the @code{perl Makefile.PL} step from perl
MakeMaker.pm-style modules. The default command is @code{./configure}
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
+ at bsindex buildbot.process.step.Compile
+
This is meant to handle compiling or building a project written in C. The
default command is @code{make all}. When the compile is finished, the
log file is scanned for GCC error/warning messages and a summary log is
@@ -3481,9 +3503,10 @@
created).
@node Test, Build Properties, Compile, Simple ShellCommand Subclasses
- at bsindex buildbot.process.step.Test
@subsubsection Test
+ at bsindex buildbot.process.step.Test
+
This is meant to handle unit tests. The default command is @code{make
test}, and the @code{warnOnFailure} flag is set.
@@ -3761,10 +3784,11 @@
@node Interlocks, Build Factories, Build Steps, Build Process
+ at section Interlocks
+
@cindex locks
@slindex buildbot.locks.MasterLock
@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
@@ -3973,12 +3997,18 @@
to later builds.
+ at menu
+* BuildFactory Attributes::
+* Quick builds::
+ at end menu
+
@node BuildFactory, Process-Specific build factories, BuildStep Objects, Build Factories
+ at subsection BuildFactory
+
@bfindex buildbot.process.factory.BuildFactory
@bfindex buildbot.process.factory.BasicBuildFactory
@c TODO: what is BasicSVN anyway?
@bfindex buildbot.process.factory.BasicSVN
- at subsection BuildFactory
The default @code{BuildFactory}, provided in the
@code{buildbot.process.factory} module, is constructed with a list of
@@ -4077,9 +4107,10 @@
@node Quick builds, , BuildFactory Attributes, BuildFactory
- at bfindex buildbot.process.factory.QuickBuildFactory
@subsubsection Quick builds
+ at bfindex buildbot.process.factory.QuickBuildFactory
+
The difference between a ``full build'' and a ``quick build'' is that
quick builds are generally done incrementally, starting with the tree
where the previous build was performed. That simply means that the
@@ -4109,9 +4140,10 @@
@end menu
@node GNUAutoconf, CPAN, Process-Specific build factories, Process-Specific build factories
- at bfindex buildbot.process.factory.GNUAutoconf
@subsubsection GNUAutoconf
+ at bfindex buildbot.process.factory.GNUAutoconf
+
@uref{http://www.gnu.org/software/autoconf/, GNU Autoconf} is a
software portability tool, intended to make it possible to write
programs in C (and other languages) which will run on a variety of
@@ -4186,9 +4218,10 @@
@node CPAN, Python distutils, GNUAutoconf, Process-Specific build factories
- at bfindex buildbot.process.factory.CPAN
@subsubsection CPAN
+ at bfindex buildbot.process.factory.CPAN
+
Most Perl modules available from the @uref{http://www.cpan.org/, CPAN}
archive use the @code{MakeMaker} module to provide configuration,
build, and test services. The standard build routine for these modules
@@ -4220,9 +4253,10 @@
@node Python distutils, Python/Twisted/trial projects, CPAN, Process-Specific build factories
- at bfindex buildbot.process.factory.Distutils
@subsubsection Python distutils
+ at bfindex buildbot.process.factory.Distutils
+
Most Python modules use the @code{distutils} package to provide
configuration and build services. The standard build process looks
like:
@@ -4261,6 +4295,8 @@
@node Python/Twisted/trial projects, , Python distutils, Process-Specific build factories
+ at subsubsection Python/Twisted/trial projects
+
@bfindex buildbot.process.factory.Trial
@c TODO: document these steps better
@bsindex buildbot.process.step_twisted.HLint
@@ -4268,7 +4304,6 @@
@bsindex buildbot.process.step_twisted.ProcessDocs
@bsindex buildbot.process.step_twisted.BuildDebs
@bsindex buildbot.process.step_twisted.RemovePYCs
- at subsubsection Python/Twisted/trial projects
Twisted provides a unit test tool named @code{trial} which provides a
few improvements over Python's built-in @code{unittest} module. Many
@@ -4459,9 +4494,10 @@
@c DOCUMENT THIS
@node HTML Waterfall, IRC Bot, Status Delivery, Status Delivery
+ at section HTML Waterfall
+
@cindex Waterfall
@stindex buildbot.status.html.Waterfall
- at section HTML Waterfall
@example
@@ -4541,9 +4577,10 @@
@node IRC Bot, PBListener, HTML Waterfall, Status Delivery
+ at section IRC Bot
+
@cindex IRC
@stindex buildbot.status.words.IRC
- at section IRC Bot
The @code{buildbot.status.words.IRC} status target creates an IRC bot
@@ -4612,9 +4649,10 @@
@end table
@node PBListener, Writing New Status Plugins, IRC Bot, Status Delivery
+ at section PBListener
+
@cindex PBListener
@stindex buildbot.status.client.PBListener
- at section PBListener
@example
More information about the Commits
mailing list