[Zope-Checkins] CVS: Zope/lib/python/Products/OFSP/help - Database-Management_Cache-Parameters.stx:1.3 Database-Management_Flush-Cache.stx:1.3 Properties.stx:1.3

[Toby Dickenson]

Update of /cvs-repository/Zope/lib/python/Products/OFSP/help
In directory cvs.zope.org:/tmp/cvs-serv10497/lib/python/Products/OFSP/help

Modified Files:
	Database-Management_Cache-Parameters.stx 
	Database-Management_Flush-Cache.stx Properties.stx 
Log Message:
merged toby-stiff-cache-branch and toby-unicode-branch

=== Zope/lib/python/Products/OFSP/help/Database-Management_Cache-Parameters.stx 1.2 => 1.3 ===
     This view allows you to view Zope database cache statistics and
     set cache parameters. The Zope database cache operates by keeping
-    frequently used objects in memory to improve performance. A large
+    recently used objects in memory to improve performance. A large
     cache improves object access speed, but increases memory usage. A
     small cache reduces memory usage but may slow down object access
     speed.
 
-    Information
+  Information
 
-
-      'Total number of objects in the database' -- Indicates the
-      number of *persistent* objects in the Zope database.
-
-      'Total number of objects in all the caches combined' --
-      Indicates the number of objects which are currently cached in
-      memory.
-
-Controls
-
-    'Target size' -- Indicates ideal number of objects to have in
-    memory at any given time. This controls the size of the Zope
-    database cache.
-
-    'Target maximum time between accesses' -- Indicates the amount of
-    time after which Zope should remove an object from memory if it
-    hasn't been accessed. This controls how quickly the Zope database
-    cache removes objects that aren't being used.
+    'Total number of objects in the database' -- Indicates the
+    number of persistent objects in the Zope database. All of these
+    objects are stored on disk, some of them are in memory too.
+
+    'Total number of objects in memory from all caches' --
+    Indicates the number of objects which are currently
+    cached in memory. This is a good indication of the amount
+    of memory used by Zope.
+
+    'Target number of objects in memory per cache' -- Indicates
+    the target number of objects to have in each cache at any
+    given time. Zope will allow the number of objects to grow
+    above this number while processing a request, but will always
+    reduce the level to this number at the end of each request.
+
+     This parameter is one factor affecting the amount of memory
+     use by Zope. It controls the amount of memory used per cache,
+     the other factor is the number of caches. In general,
+     Zope uses one cache per worker thread (specified by the '-t'
+     switch on the command line)
+
+    'Total number of objects in each cache' -- This table displays
+    one row for each object cache.
+
+     'Number of objects in memory' --  This value should not stay
+     larger than the configured target size for longer than one
+     transaction.
+
+      Note that the total number at the bottom of this column
+      should be the same as the figure in the top half of the
+      page. It may be slightly different because there is a small
+      time interval between the calculation of the two totals.
+
+     'Number of ghost objects' -- Ghost objects are those
+     which only have a tiny memory footprint because their full
+     state has not been loaded. You generally do not need to
+     worry about the number of ghost objects because they are
+     so small.
+    


=== Zope/lib/python/Products/OFSP/help/Database-Management_Flush-Cache.stx 1.2 => 1.3 ===
   Controls
 
-    'Full Sweep' -- Allows you to remove objects from the cache. The 
-    associated field (with the default value of 60 seconds) indicates 
-    the number of seconds within which an object must have been 
-    accessed in order *not* to be deactivated by  the flush operation.
+    'Minimize' -- Allows you to remove all persistent objects from
+    memory. They will be reloaded again on demand, when they
+    are next accessed.
 
-    'Minimize' -- Allows you to remove objects from
-    the cache. The field (with the  default value of 60 seconds)
-    indicates the number of seconds within which an object must have
-    been accessed in order not to be deactivated by the flush
-    operation.
-
-      The minimize operation differs from the full sweep in that it
-      removes all objects which are no longer referenced from the
-      root, while the full sweep merely removes most objects. The
-      minimize operation takes longer than full sweep.


=== Zope/lib/python/Products/OFSP/help/Properties.stx 1.2 => 1.3 ===
       'int' -- An integer number, for example, '12'. 
 
-      'lines' -- A list of strings, one per line. 
+      'lines', 'ulines' -- A list of strings, one per line. 
 
       'long' -- A long integer, for example '12232322322323232323423'. 
 
-      'string' -- A string of characters, for example 'This is a string'. 
+      'string', 'ustring' -- A string of characters, for example 'This is a string'. 
 
-      'text' -- A multi-line string, for example a paragraph. 
+      'text', 'utext' -- A multi-line string, for example a paragraph. 
 
-      'tokens' -- A list of strings separated by white space, for example
+      'tokens', 'utokens' -- A list of strings separated by white space, for example
       'one two three'. 
 
       'selection' -- A string selected by a pop-up menu. 
 
       'multiple selection' -- A list of strings selected by a selection list.
+
+      Some of these textual properties come in two forms. The 'u'-prefixed
+      form stores Unicode text. The form without the prefix stores a python
+      plain string object, which is commonly assumed to contain latin-1
+      text.
 
   Controls