Update Gc.control documentation to OCaml 5#13440
Merged
Merged
Conversation
126877d to
1abc381
Compare
Member
Author
|
Rebased on |
ghost
reviewed
Sep 18, 2024
gasche
approved these changes
Sep 20, 2024
gasche
left a comment
Member
There was a problem hiding this comment.
I warmly welcome documentation improvements. Thanks! Approved.
1abc381 to
28aefb4
Compare
Member
Author
|
Thanks, I've updated Would be good to cherry-pick this one to 5.3 along with #13424 (the latter first then this one, to avoid |
dra27
pushed a commit
that referenced
this pull request
Oct 2, 2024
Update Gc.control documentation to OCaml 5 (cherry picked from commit b516815)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While continuing on a
Gcmodule test I spotted a bit more documentation needing updating on OCaml 5:major_heap_increment,max_overhead, andwindow_size) are out of date, as they are unavailable. I've slightly adjusted the existing documentation ofallocation_policyto make the four of them uniformstack_limit's documented default should reflect OCaml 5's much higher default valueI can see that the
stack_limitwas adjusted in #11238 as part of the 5.0 releaseand that the manual was updated in #13066 as part of the 5.2 release.
For easy reference, the relevant parts underlying
Gc.getdoes not extract fields 1, 4, 6, and 7:ocaml/runtime/gc_ctrl.c
Lines 122 to 136 in f2ff4a4
and the same is true for
Gc.set:ocaml/runtime/gc_ctrl.c
Lines 155 to 163 in f2ff4a4
The default stack size is documented in these lines (note: it is 128M words):
ocaml/runtime/caml/config.h
Lines 195 to 197 in f2ff4a4