[Buildbot-commits] buildbot/docs buildbot.texinfo,1.4,1.5

[Brian Warner]

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

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

clean up 'buildbot start', change to Makefile.buildbot

	* buildbot/scripts/runner.py (start): change 'buildbot start' to
	look for Makefile.buildbot instead of a bare Makefile . The
	'buildbot start' does not install this file, so you have to
	manually copy it if you want to customize startup behavior.
	(createMaster): change 'buildbot master' command to create
	Makefile.sample instead of Makefile, to create master.cfg.sample
	instead of master.cfg (requiring you to copy it before the
	buildmaster can be started). Both sample files are kept up to
	date, i.e. they are overwritten if they have been changed. The
	'buildbot.tac' file is *not* overwritten, but if the new contents
	don't match the old, a 'buildbot.tac.new' file is created and the
	user is warned. This seems to be a much more sane way to handle
	startup files. Also, don't sys.exit(0) when done, so we can run
	unit tests against it.
	(createSlave): same. Don't overwrite the sample info/ files.
	* buildbot/scripts/sample.mk: remove. the contents were pulled
	into runner.py, since they need to match the behavior of start()
	* setup.py: same
	* MANIFEST.in: same


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- buildbot.texinfo	17 May 2005 04:40:57 -0000	1.4
+++ buildbot.texinfo	17 May 2005 20:04:20 -0000	1.5
@@ -532,8 +532,8 @@
 You will need to create a configuration file (@pxref{Configuration})
 before starting the buildmaster. Most of the rest of this manual is
 dedicated to explaining how to do this. A sample configuration file is
-placed in the working directory, named @file{master.cfg}, which can be
-edited to suit your purposes.
+placed in the working directory, named @file{master.cfg.sample}, which
+can be copied to @file{master.cfg} and edited to suit your purposes.
 
 Internal details:
 
@@ -544,10 +544,9 @@
 (running the program in the background). @file{/usr/bin/buildbot} is a
 front end which runs twistd for you.
 
-In addition to @file{buildbot.tac}, a small Makefile is created for
-performing common actions. The @file{buildbot} front-end tool can do
-most of these actions for you, so eventually the Makefile will be
-redundant.
+In addition to @file{buildbot.tac}, a small @file{Makefile.sample} is
+installed. This can be used as the basis for customize daemon startup,
+ at xref{Launching the daemons}.
 
 
 @node Creating a buildslave, Launching the daemons, Creating a buildmaster, Installation
@@ -729,6 +728,18 @@
 @code{PATH}, or for @code{PYTHONPATH} to not be set correctly.
 Sometimes @code{HOME} is messed up too.
 
+To modify the way the daemons are started (perhaps you want to set
+some environment variables first, or perform some cleanup each time),
+you can create a file named @file{Makefile.buildbot} in the base
+directory. When the @file{buildbot} front-end tool is told to
+ at command{start} the daemon, and it sees this file (and
+ at file{/usr/bin/make} exists), it will do @command{make -f
+Makefile.buildbot start} instead of its usual action (which involves
+running @command{twistd}). When the buildmaster or buildslave is
+installed, a @file{Makefile.sample} is created which implements the
+same behavior as the the @file{buildbot} tool uses, so if you want to
+customize the process, just copy @file{Makefile.sample} to
+ at file{Makefile.buildbot} and edit it as necessary.
 
 @node Logfiles, Shutdown, Launching the daemons, Installation
 @section Logfiles