--- code/trunk/maint/README	2007/08/09 11:16:34	212
+++ code/trunk/maint/README	2008/07/04 18:27:16	351
@@ -16,22 +16,35 @@
 Files in the maint directory
 ----------------------------
 
+----------------- This file is now OBSOLETE and no longer used ----------------
 Builducptable    A Perl script that creates the contents of the ucptable.h file
                  from two Unicode data files, which themselves are downloaded
                  from the Unicode web site. Run this script in the "maint"
                  directory.
+----------------- This file is now OBSOLETE and no longer used ----------------
+
+GenerateUtt.py   A Python script to generate part of the pcre_tables.c file
+                 that contains Unicode script names in a long string with
+                 offsets, which is tedious to maintain by hand. 
 
 ManyConfigTests  A shell script that runs "configure, make, test" a number of
                  times with different configuration settings.
-
-Unicode.tables   The files in this directory, Scripts.txt and UnicodeData.txt,
-                 were downloaded from the Unicode web site. They contain
-                 information about Unicode characters and scripts.
-
-ucptest.c        A short C program for testing the Unicode property functions
-                 in pcre_ucp_searchfuncs.c, mainly useful after rebuilding the
-                 Unicode property table. Compile and run this in the "maint"
-                 directory.
+                 
+MultiStage2.py   A Python script that generates the file pcre_ucd.c from three
+                 Unicode data tables, which are themselves downloaded from the
+                 Unicode web site. Run this script in the "maint" directory. 
+                 The generated file contains the tables for a 2-stage lookup
+                 of Unicode properties.  
+
+Unicode.tables   The files in this directory, DerivedGeneralCategory.txt, 
+                 Scripts.txt and UnicodeData.txt, were downloaded from the
+                 Unicode web site. They contain information about Unicode
+                 characters and scripts.
+
+ucptest.c        A short C program for testing the Unicode property macros
+                 that do lookups in the pcre_ucd.c data, mainly useful after
+                 rebuilding the Unicode property table. Compile and run this in
+                 the "maint" directory (see comments at its head).
 
 ucptestdata      A directory containing two files, testinput1 and testoutput1,
                  to use in conjunction with the ucptest program.
@@ -49,10 +62,15 @@
 ---------------------------------
 
 When there is a new release of Unicode, the files in Unicode.tables must be
-refreshed from the web site, and the Buildupctable script can then be run to
-generate a new version of ucptable.h. The ucptest program can be used to check
-that the resulting table works properly, using the data files in ucptestdata to
-check a number of test characters.
+refreshed from the web site. If the new version of Unicode adds new character 
+scripts, both the MultiStage2.py and the GenerateUtt.py scripts must be edited 
+to add the new names. Then the MultiStage2.py script can then be run to
+generate a new version of pcre_ucd.c and the GenerateUtt.py can be run to 
+generate the tricky tables in pcre_tables.c.
+
+The ucptest program can then be compiled and used to check that the new tables
+in pcre_ucd.c work properly, using the data files in ucptestdata to check a
+number of test characters.
 
 
 Preparing for a PCRE release
@@ -63,6 +81,9 @@
 
 . Ensure that the version number and version date are correct in configure.ac,
   ChangeLog, and NEWS.
+  
+. If new build options have been added, ensure that they are added to the CMake
+  files as well as to the autoconf files. 
 
 . Run ./autogen.sh to ensure everything is up-to-date.
 
@@ -241,4 +262,4 @@
 Philip Hazel
 Email local part: ph10
 Email domain: cam.ac.uk
-Last updated: 09 August 2007
+Last updated: 04 July 2008