[CMF-checkins] SVN: CMF/branches/jens_tools_as_utilities/ - add a little documentation about the upgrade script

[Jens Vagelpohl]

Log message for revision 72961:
  - add a little documentation about the upgrade script
  

Changed:
  U   CMF/branches/jens_tools_as_utilities/CHANGES.txt
  U   CMF/branches/jens_tools_as_utilities/INSTALL.txt

-=-
Modified: CMF/branches/jens_tools_as_utilities/CHANGES.txt
===================================================================
--- CMF/branches/jens_tools_as_utilities/CHANGES.txt	2007-03-02 13:20:56 UTC (rev 72960)
+++ CMF/branches/jens_tools_as_utilities/CHANGES.txt	2007-03-02 13:47:01 UTC (rev 72961)
@@ -1,5 +1,10 @@
 CMF 2.1.0-beta (unreleased)
 
+  IMPORTANT NOTE:
+
+    If you upgrade an existing CMF instance to CMF 2.1, please see
+    INSTALL.txt for instructions on how to run a separate upgrade script.
+
   New Features
 
     - WorkflowTool: Added the IConfigurableWorkflowTool interface.

Modified: CMF/branches/jens_tools_as_utilities/INSTALL.txt
===================================================================
--- CMF/branches/jens_tools_as_utilities/INSTALL.txt	2007-03-02 13:20:56 UTC (rev 72960)
+++ CMF/branches/jens_tools_as_utilities/INSTALL.txt	2007-03-02 13:47:01 UTC (rev 72961)
@@ -61,6 +61,23 @@
        site creation.
 
 
+Important Note for users upgrading existing CMF instances to CMF 2.1
+
+  In order to make CMF instances created in CMF versions prior to CMF 2.1
+  work, you need to run a separate one-time upgrade script. After putting the
+  new code in place as instructed above, please change into your instance
+  home and execute the following as the user normally running this Zope
+  instance:
+
+    ./bin/zopectl run Products/CMFCore/Extensions/migrateToCMF21.py
+
+  The script will print some diagnostic information to the console and 
+  inform you about CMF sites it finds and upgrades. Once the script has
+  finished, you can start and use your Zope instance as before. This script
+  only needs to be run a single time when you start using a CMF version
+  2.1.0-beta or higher.
+
+
 Installing Translations for CMF
 
   Assumptions