Skip to content

Add documentation for Runtime_events events#13382

Merged
kayceesrk merged 1 commit into
ocaml:trunkfrom
sadiqj:runtime_events_events_doc
Aug 20, 2024
Merged

Add documentation for Runtime_events events#13382
kayceesrk merged 1 commit into
ocaml:trunkfrom
sadiqj:runtime_events_events_doc

Conversation

@sadiqj

@sadiqj sadiqj commented Aug 18, 2024

Copy link
Copy Markdown
Contributor

Should be of interest to at least @kayceesrk and @tmcgilchrist

We could probably flesh these out further over time.

@tmcgilchrist tmcgilchrist left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good improvement to the documentation, thank you. 👍🏻

Minor question, there is no corresponding event for caml_adjust_minor_gc_speed. Does it make sense to have one for that? It seemed out of place when caml_adjust_gc_speed emits an event and this one doesn't.

ocaml/runtime/memory.c

Lines 281 to 285 in 8bbb374

/* This function is analogous to [caml_adjust_gc_speed]. When the
accumulated sum of [res/max] values reaches 1, a minor GC is
triggered.
*/
CAMLexport void caml_adjust_minor_gc_speed (mlsize_t res, mlsize_t max)

Comment thread otherlibs/runtime_events/runtime_events.mli
Comment thread otherlibs/runtime_events/runtime_events.mli Outdated

@kayceesrk kayceesrk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is much appreciated. Thank you.

@sadiqj

sadiqj commented Aug 19, 2024

Copy link
Copy Markdown
Contributor Author

Minor question, there is no corresponding event for caml_adjust_minor_gc_speed. Does it make sense to have one for that? It seemed out of place when caml_adjust_gc_speed emits an event and this one doesn't.

Yes, I think this would be a good idea.

@kayceesrk

Copy link
Copy Markdown
Contributor

I'd be happy to merge once https://github.com/ocaml/ocaml/pull/13382/files#r1722740060 is resolved.

@kayceesrk

Copy link
Copy Markdown
Contributor

The CHANGES entry also needs to be updated.

@kayceesrk kayceesrk force-pushed the runtime_events_events_doc branch from d49068a to 390bf18 Compare August 20, 2024 08:54
@kayceesrk

Copy link
Copy Markdown
Contributor

I've updated the Changes file and squashed the commits at @sadiqj's request.

@kayceesrk kayceesrk merged commit 6244b76 into ocaml:trunk Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants