Skip to content

Commit 9d64c52

Browse files
authored
docs: update outdated docs on moving GCs not being supported (#11659)
1 parent a740e34 commit 9d64c52

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

cranelift/frontend/src/frontend.rs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -420,9 +420,10 @@ impl<'a> FunctionBuilder<'a> {
420420
/// map metadata.
421421
///
422422
/// All values that are uses of this variable will be spilled to the stack
423-
/// before each safepoint and their location on the stack included in stack
424-
/// maps. Stack maps allow the garbage collector to identify the on-stack GC
425-
/// roots.
423+
/// before each safepoint and reloaded afterwards. Stack maps allow the
424+
/// garbage collector to identify the on-stack GC roots. Between spilling
425+
/// the stack and it being reloading again, the stack can be updated to
426+
/// facilitate moving GCs.
426427
///
427428
/// This does not affect any pre-existing uses of the variable.
428429
///
@@ -536,10 +537,11 @@ impl<'a> FunctionBuilder<'a> {
536537
/// Declare that the given value is a GC reference that requires inclusion
537538
/// in a stack map when it is live across GC safepoints.
538539
///
539-
/// At the current moment, values that need inclusion in stack maps are
540-
/// spilled before safepoints, but they are not reloaded afterwards. This
541-
/// means that moving GCs are not yet supported, however the intention is to
542-
/// add this support in the near future.
540+
/// All values that are uses of this variable will be spilled to the stack
541+
/// before each safepoint and reloaded afterwards. Stack maps allow the
542+
/// garbage collector to identify the on-stack GC roots. Between spilling
543+
/// the stack and it being reloading again, the stack can be updated to
544+
/// facilitate moving GCs.
543545
///
544546
/// # Panics
545547
///

0 commit comments

Comments
 (0)