Skip to content

Commit de10fa4

Browse files
qinsoonwks
andauthored
Update migration guide for #1205 (#1211)
Co-authored-by: Kunshan Wang <[email protected]>
1 parent 7cfebda commit de10fa4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/userguide/src/migration/prefix.md

+21
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ Notes for the mmtk-core developers:
3232

3333
## 0.28.0
3434

35+
### `handle_user_collection_request` returns `bool`
36+
37+
```admonish tldr
38+
`memory_manager::handle_user_collection_request` now returns a boolean value to indicate whether a GC
39+
is triggered by the method or not. Bindings may use the return value to do some post-gc cleanup, or
40+
simply ignore the return value.
41+
```
42+
43+
API changes:
44+
45+
- module `memory_manager`
46+
+ `handle_user_collection_request` now returns `bool` to indicate if a GC is triggered by the method.
47+
Bindings may use the value, or simply ignore it.
48+
49+
See also:
50+
51+
- PR: <https://github.com/mmtk/mmtk-core/issues/1205>
52+
- Examples:
53+
+ https://github.com/mmtk/mmtk-julia/pull/177: Ignore return value.
54+
55+
3556
### `ObjectReference` must point inside an object
3657

3758
```admonish tldr

0 commit comments

Comments
 (0)