diff options
Diffstat (limited to 'byterun/memory.h')
| -rw-r--r-- | byterun/memory.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/byterun/memory.h b/byterun/memory.h index cbeeb756f..dddf9a36b 100644 --- a/byterun/memory.h +++ b/byterun/memory.h @@ -181,7 +181,7 @@ CAMLextern struct caml__roots_block *caml_local_roots; /* defined in roots.c */ your function. Do NOT directly return a [value] with the [return] keyword. If your function returns void, use [CAMLreturn0]. - All the identifiers beginning with "caml__" are reserved by Caml. + All the identifiers beginning with "caml__" are reserved by OCaml. Do not use them for anything (local or global variables, struct or union tags, macros, etc.) */ @@ -346,7 +346,7 @@ CAMLextern struct caml__roots_block *caml_local_roots; /* defined in roots.c */ It must contain all values in C local variables and function parameters at the time the minor GC is called. Usage: - After initialising your local variables to legal Caml values, but before + After initialising your local variables to legal OCaml values, but before calling allocation functions, insert [Begin_roots_n(v1, ... vn)], where v1 ... vn are your variables of type [value] that you want to be updated across allocations. @@ -440,7 +440,7 @@ CAMLextern void caml_remove_global_root (value *); the value of this variable, it must do so by calling [caml_modify_generational_global_root]. The [value *] pointer passed to [caml_register_generational_global_root] must contain - a valid Caml value before the call. + a valid OCaml value before the call. In return for these constraints, scanning of memory roots during minor collection is made more efficient. */ |