[Buildbot-commits] buildbot/docs buildbot.texinfo,1.121,1.122

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ upgrade-master: check master.cfg for problems, add docs]

Original author: warner at lothar.com
Date: 2007-09-30 07:13:39+00:00

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.121
retrieving revision 1.122
diff -u -d -r1.121 -r1.122
--- buildbot.texinfo	29 Sep 2007 01:07:56 -0000	1.121
+++ buildbot.texinfo	30 Sep 2007 07:14:23 -0000	1.122
@@ -83,6 +83,7 @@
 * Requirements::                
 * Installing the code::         
 * Creating a buildmaster::      
+* Upgrading an Existing Buildmaster::  
 * Creating a buildslave::       
 * Launching the daemons::       
 * Logfiles::                    
@@ -600,6 +601,7 @@
 * Requirements::                
 * Installing the code::         
 * Creating a buildmaster::      
+* Upgrading an Existing Buildmaster::  
 * Creating a buildslave::       
 * Launching the daemons::       
 * Logfiles::                    
@@ -718,7 +720,7 @@
 @code{PYTHONPATH}.
 
 
- at node Creating a buildmaster, Creating a buildslave, Installing the code, Installation
+ at node Creating a buildmaster, Upgrading an Existing Buildmaster, Installing the code, Installation
 @section Creating a buildmaster
 
 As you learned earlier (@pxref{System Architecture}), the buildmaster
@@ -770,8 +772,41 @@
 installed. This can be used as the basis for customized daemon startup,
 @xref{Launching the daemons}.
 
+ at node Upgrading an Existing Buildmaster, Creating a buildslave, Creating a buildmaster, Installation
+ at section Upgrading an Existing Buildmaster
 
- at node Creating a buildslave, Launching the daemons, Creating a buildmaster, Installation
+If you have just installed a new version of the Buildbot code, and you
+have buildmasters that were created using an older version, you'll
+need to upgrade these buildmasters before you can use them. The
+upgrade process adds and modifies files in the buildmaster's base
+directory to make it compatible with the new code.
+
+ at example
+buildbot upgrade-master @var{basedir}
+ at end example
+
+This command will also scan your @file{master.cfg} file for
+incompatbilities (by loading it and printing any errors or deprecation
+warnings that occur). Each buildbot release tries to be compatible
+with configurations that worked cleanly (i.e. without deprecation
+warnings) on the previous release: any functions or classes that are
+to be removed will first be deprecated in a release, to give users a
+chance to start using their replacement.
+
+The 0.7.6 release introduced the @file{public_html/} directory, which
+contains @file{index.html} and other files served by the
+ at code{WebStatus} and @code{Waterfall} status displays. The
+ at code{upgrade-master} command will create these files if they do not
+already exist. It will not modify existing copies, but it will write a
+new copy in e.g. @file{index.html.new} if the new version differs from
+the version that already exists.
+
+The @code{upgrade-master} command is idempotent. It is safe to run it
+multiple times. After each upgrade of the buildbot code, you should
+use @code{upgrade-master} on all your buildmasters.
+
+
+ at node Creating a buildslave, Launching the daemons, Upgrading an Existing Buildmaster, Installation
 @section Creating a buildslave
 
 Typically, you will be adding a buildslave to an existing buildmaster,