*** empty log message ***

svn path=/trunk/boinc/; revision=4480

doc/tool_upgrade.php

@@ -1,38 +1,38 @@
 <?php
    require_once("docutil.php");
    page_head("Upgrading project software");
+?>
 
-echo "
-    The script <b>bin/upgrade</b> copies files from
-    a BOINC source tree to a project tree.
-    This is typically done after updating the source tree
-    and recompiling the software.
-    The script must reside in the project's bin/ directory,
-    and you must run it from the source tree root.
 <p>
-    NOTE: if you are upgrading from a BOINC source tree
+  The script <b>bin/upgrade</b> copies files from a BOINC source tree to a
-    in a different location than the original,
+  project tree.  This is typically done after updating the source tree and
-    you must manually edit the file
+  recompiling the software.  The script must reside in the project's bin/
-    boinc_path_config.py in the project's bin/ directory
+  directory, and you must run it from the source tree root.
-    (and delete the file boinc_path_config.pyc).
+</p>
-    Change the values of TOP_BUILD_DIR and TOP_SOURCE_DIR
+
-    to point to your new BOINC source tree.
+<p>
+  <code>upgrade</code> takes optional environment variables INSTALL_DIR and
+  TOP_SOURCE_DIR if the installation directory or source directory are
+  different from your previous installation.
+</p>
+
 <p>
   <b>upgrade</b> does the following:
   <ul>
     <li>
-    It copies files from the source/html/* directories
+      It copies files from the source/html/* directories to the corresponding
-    to the corresponding project directories.
+      project directories.
     <li>
-    It copies source/sched/cgi and source/sched/file_upload_handler
+      It copies source/sched/cgi and source/sched/file_upload_handler to
-    to projects/cgi-bin.
+      projects/cgi-bin.
     <li>
       It copies other programs in source/sched to project/bin.
     <li>
       It copies programs in source/tools to project/bin.
   </ul>
+</p>
 
-";
+<?php
    page_tail();
 ?>