Added commentage to the dbinit files to help people with their

[roundup.git] / MIGRATION.txt

diff --git a/MIGRATION.txt b/MIGRATION.txt
index 5de7618c6ed86bc8aeb8a548b1151fc8e9954e30..7730c360e46b72e95a5322541805f397ed4cfba4 100644 (file)
--- a/MIGRATION.txt
+++ b/MIGRATION.txt
@@ -9,6 +9,34 @@ This file contains information for users upgrading from:
   0.3.x -> 0.4.x
   0.2.x -> 0.3.x
 
+From CVS
+========
+
+Files storage
+-------------
+
+Messages and files from newly created issues will be put into subdierectories
+in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003
+will go into files/file/2/file2003. Previous messages are still found, but
+could be put into this structure.
+
+Migrating from 0.4.0 to 0.4.1
+=============================
+
+Configuration
+-------------
+
+The USER_INDEX definition introduced in 0.4.1 was too restrictive in its
+allowing replacement of 'assignedto' with the user's userid. Users must change
+the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for
+the replacement behaviour to occur now.
+
+The new configuration variables are:
+
+- EMAIL_KEEP_QUOTED_TEXT 
+- EMAIL_LEAVE_BODY_UNCHANGED
+- ADD_RECIPIENTS_TO_NOSY
+
 
 Migrating from 0.4.0 to 0.4.1
 =============================
@@ -21,6 +49,26 @@ permission to auto-register users in the mail gateway is now called
 ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the
 variable doesn't exist, then ANONYMOUS_REGISTER is tested as before.
 
+Configuring the links in the web header is now easier too. The following
+variables have been added to the classic instance_config.py:
+
+  HEADER_INDEX_LINKS   - defines the "index" links to be made available
+  HEADER_ADD_LINKS     - defines the "add" links
+  DEFAULT_INDEX        - specifies the index view for DEFAULT
+  UNASSIGNED_INDEX     - specifies the index view for UNASSIGNED
+  USER_INDEX           - specifies the index view for USER
+
+See the <roundup source>/roundup/templates/classic/instance_config.py for more
+information - including how the variables are to be set up. Most users will
+just be able to copy the variables from the source to their instance home. If
+you've modified the header by changing the source of the interfaces.py file in
+the instance home, you'll need to remove that customisation and move it into
+the appropriate variables in instance_config.py.
+
+The extended schema has similar variables added too - see the source for more
+info.
+
+
 
 Alternate E-Mail Addresses
 --------------------------
@@ -46,9 +94,9 @@ class:
 
     user = Class(db, "msg",
                     username=String(),   password=Password(),
-                   address=String(),    realname=String(), 
-                   phone=String(),      organisation=String(),
-                   alternate_addresses=String())
+                    address=String(),    realname=String(), 
+                    phone=String(),      organisation=String(),
+                    alternate_addresses=String())
 
 You will also want to add the property to the user's details page. The
 template for this is the "user.item" file in your instance home "html"