diff options
| author | Guillaume Munch-Maccagnoni <Guillaume.Munch-Maccagnoni@Inria.fr> | 2020-01-24 17:21:07 -0300 |
|---|---|---|
| committer | Guillaume Munch-Maccagnoni <Guillaume.Munch-Maccagnoni@Inria.fr> | 2020-01-28 16:35:01 -0300 |
| commit | eb99690b191a438ed7f8bc8fd018351b39ddebf4 (patch) | |
| tree | 26da906437e60c1fb972fd0739da7d0f1a2d9d22 /stdlib/stdlib.mli | |
| parent | be66c9c4dba1e97959a50608caeafda809150064 (diff) | |
| download | ocaml-eb99690b191a438ed7f8bc8fd018351b39ddebf4.tar.gz | |
Documentation: Stack_overflow is reliable, Out_of_memory is not.
Stack overflow detection is fixed in 4.10 at #8670.
No changes needed.
Diffstat (limited to 'stdlib/stdlib.mli')
| -rw-r--r-- | stdlib/stdlib.mli | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/stdlib/stdlib.mli b/stdlib/stdlib.mli index 7087901a81..737e37d91e 100644 --- a/stdlib/stdlib.mli +++ b/stdlib/stdlib.mli @@ -79,13 +79,16 @@ exception Not_found exception Out_of_memory (** Exception raised by the garbage collector when there is - insufficient memory to complete the computation. *) + insufficient memory to complete the computation. (Not reliable for + allocations on the minor heap.) *) exception Stack_overflow (** Exception raised by the bytecode interpreter when the evaluation stack reaches its maximal size. This often indicates infinite or - excessively deep recursion in the user's program. (Not fully - implemented by the native-code compiler.) *) + excessively deep recursion in the user's program. + + Before 4.10, it was not fully implemented by the native-code + compiler. *) exception Sys_error of string [@ocaml.warn_on_literal_pattern] |