boehm-gc: revert all CACAO-specific modifications; this is now an exact copy of the...

[cacao.git] / src / mm / boehm-gc / doc / README.environment

diff --git a/src/mm/boehm-gc/doc/README.environment b/src/mm/boehm-gc/doc/README.environment
index d50d37094c79ceedeb62db891375607d5fd4cc0f..a5e110e36551ddb26440479a923f65b53b68a064 100644 (file)
--- a/src/mm/boehm-gc/doc/README.environment
+++ b/src/mm/boehm-gc/doc/README.environment
@@ -46,7 +46,7 @@ GC_NPROCS=<n> - Linux w/threads only.  Explicitly sets the number of processors
                since the lock implementation will immediately yield without
                first spinning.
 
-GC_MARKERS=<n> - Linux w/threads and parallel marker only.  Set the number
+GC_MARKERS=<n> - Only if compiled with PARALLEL_MARK.  Set the number
                of marker threads.  This is normally set to the number of
                processors.  It is safer to adjust GC_MARKERS than GC_NPROCS,
                since GC_MARKERS has no impact on the lock implementation.
@@ -94,6 +94,17 @@ GC_RETRY_SIGNALS, GC_NO_RETRY_SIGNALS - Try to compensate for lost
                     was turned into a runtime flag to enable last-minute
                     work-arounds.
 
+GC_USE_GETWRITEWATCH=<n> - Only if MPROTECT_VDB and GWW_VDB are both defined
+                    (Win32 only).  Explicitly specify which strategy of
+                    keeping track of dirtied pages should be used.
+                    If n=0 then GetWriteWatch() is not used (falling back to
+                    protecting pages and catching memory faults strategy)
+                    else the collector tries to use GetWriteWatch-based
+                    strategy (GWW_VDB) first if available.
+
+GC_DISABLE_INCREMENTAL - Ignore runtime requests to enable incremental GC.
+                    Useful for debugging.
+
 The following turn on runtime flags that are also program settable.  Checked
 only during initialization.  We expect that they will usually be set through
 other means, but this may help with debugging and testing:
@@ -118,6 +129,13 @@ GC_PAUSE_TIME_TARGET - Set the desired garbage collector pause time in msecs.
                     run on a multiprocessor, incremental collection should
                     only be used with unlimited pause time.
 
+GC_FULL_FREQUENCY - Set the desired number of partial collections between full
+                 collections.  Matters only if GC_incremental is set.
+
+GC_FREE_SPACE_DIVISOR - Set GC_free_space_divisor to the indicated value.
+                      Setting it to larger values decreases space consumption
+                     and increases GC frequency.
+
 GC_FIND_LEAK - Turns on GC_find_leak and thus leak detection.  Forces a
               collection at program termination to detect leaks that would
               otherwise occur after the last GC.
@@ -129,7 +147,7 @@ GC_DONT_GC - Turns off garbage collection.  Use cautiously.
 
 GC_TRACE=addr - Intended for collector debugging.  Requires that the collector
                have been built with ENABLE_TRACE defined.  Causes the debugger
-               to log information about the tracing of address ranges containing
-               addr.  Typically addr is the address that contains a pointer to
-               an object that mysteriously failed to get marked.  Addr must be
-               specified as a hexadecimal integer.
+               to log information about the tracing of address ranges
+               containing addr.  Typically addr is the address that contains
+               a pointer to an object that mysteriously failed to get marked.
+               Addr must be specified as a hexadecimal integer.