gc.mli: changement de space_overhead

arg.mli: bricoles dans la doc


git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@1569 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02

2 files changed, 17 insertions, 15 deletions

diff --git a/stdlib/arg.mli b/stdlib/arg.mli
index 35e085cc8..ca14be315 100644
--- a/stdlib/arg.mli
+++ b/stdlib/arg.mli
@@ -47,7 +47,7 @@ type spec =
 
 val parse : (string * spec * string) list -> (string -> unit) -> string -> unit
 (*
-    [parse speclist anonfun errmsg] parses the command line.
+    [parse speclist anonfun usage_msg] parses the command line.
     [speclist] is a list of triples [(key, spec, doc)].
     [key] is the option keyword, it must start with a [-].
     [spec] gives the option type and the function to call when this option
@@ -60,14 +60,14 @@ val parse : (string * spec * string) list -> (string -> unit) -> string -> unit
     If an error occurs, [parse] exits the program, after printing an error
     message as follows:
 -   The reason for the error: unknown option, invalid or missing argument, etc.
--   [errmsg]
+-   [usage_msg]
 -   The list of options, each followed by the corresponding [doc] string.
 
     For the user to be able to specify anonymous arguments starting with a
     [-], include for example [("--", String anonfun, doc)] in [speclist].
 
     By default, [parse] recognizes a unit option [-help], which will
-    display [errmsg] and the list of options, and exit the program.
+    display [usage_msg] and the list of options, and exit the program.
     You can override this behaviour by specifying your own [-help]
     option in [speclist].
 *)
@@ -78,8 +78,8 @@ exception Bad of string
 
 val usage: (string * spec * string) list -> string -> unit
 (*
-    [usage speclist errmsg]
-    [speclist] and [errmsg] are the same as for [parse].  [usage]
+    [usage speclist usage_msg]
+    [speclist] and [usage_msg] are the same as for [parse].  [usage]
     prints the same error message that [parse] prints in case of
     error.
 *)
diff --git a/stdlib/gc.mli b/stdlib/gc.mli
index 58fdb1e42..cac01011f 100644
--- a/stdlib/gc.mli
+++ b/stdlib/gc.mli
@@ -71,27 +71,29 @@ type control = {
 
   (* The GC parameters are given as a [control] record.  The fields are:
 -     [minor_heap_size]  The size (in words) of the minor heap.  Changing
-             this parameter will trigger a minor collection.
+             this parameter will trigger a minor collection.  Default: 32k.
 -     [major_heap_increment]  The minimum number of words to add to the
-             major heap when increasing it.
+             major heap when increasing it.  Default: 62k.
 -     [space_overhead]  The major GC speed is computed from this parameter.
-             This is the percentage of heap space that will be "wasted"
-             because the GC does not immediatly collect unreachable
-             objects.  The GC will work more (use more CPU time and collect
+             This is the memory that will be "wasted" because the GC does not
+             immediatly collect unreachable objects.  It is expressed as a
+             percentage of the memory used for live data.
+             The GC will work more (use more CPU time and collect
              objects more eagerly) if [space_overhead] is smaller.
              The computation of the GC speed assumes that the amount
-             of live data is constant.
+             of live data is constant.  Default: 40.
 -     [max_overhead]  Heap compaction is triggered when the estimated amount
              of free memory is more than [max_overhead] percent of the amount
-             of live data.  If [max_overhead] is set to 0, heap compaction
-             is never triggered.  If [max_overhead] is set to 1, heap
+             of live data.  If [max_overhead] is set to 0, heap
              compaction is triggered at the end of each major GC cycle
              (this last setting is intended for testing purposes only).
-             The default is 0 (i.e. compaction is never triggered).
+	     If [max_overhead >= 1000000], compaction is never triggered.
+             Default: 1000000.
 -     [verbose]  This flag controls the GC messages on standard error output.
+             Default: false.
 -     [stack_limit]  The maximum size of the stack (in words).  This is only
              relevant to the byte-code runtime, as the native code runtime
-             uses the operating system's stack.
+             uses the operating system's stack.  Default: 256k.
   *)
 
 external stat : unit -> stat = "gc_stat"