Add a doc comment for the new hook

saethlin · RalfJung · web-flow · commit 8ecdefb3db7e · 2023-08-25T11:58:31.000-04:00
Co-authored-by: Ralf Jung &lt;post@ralfj.de&gt;
diff --git a/compiler/rustc_const_eval/src/interpret/machine.rs b/compiler/rustc_const_eval/src/interpret/machine.rs
@@ -472,6 +472,9 @@ pub trait Machine<'mir, 'tcx: 'mir>: Sized {
         Ok(StackPopJump::Normal)
     }
 
+    /// Called immediately after actual memory was allocated for a local
+    /// but before the local's stack frame is updated to point to that memory.
+    #[inline(always)]
     fn after_local_allocated(
         _ecx: &mut InterpCx<'mir, 'tcx, Self>,
         _frame: usize,

Original file line number	Diff line number	Diff line change
`@@ -472,6 +472,9 @@ pub trait Machine<'mir, 'tcx: 'mir>: Sized {`
`472`	`472`	`Ok(StackPopJump::Normal)`
`473`	`473`	`}`
`474`	`474`
	`475`	`+ /// Called immediately after actual memory was allocated for a local`
	`476`	`+ /// but before the local's stack frame is updated to point to that memory.`
	`477`	`+ #[inline(always)]`
`475`	`478`	`fn after_local_allocated(`
`476`	`479`	`_ecx: &mut InterpCx<'mir, 'tcx, Self>,`
`477`	`480`	`_frame: usize,`