Document is_user_relevant

saethlin · RalfJung · web-flow · commit 1ca3c293b2c1 · 2022-11-22T10:19:29.000-05:00
Co-authored-by: Ralf Jung &lt;post@ralfj.de&gt;
diff --git a/src/tools/miri/src/helpers.rs b/src/tools/miri/src/helpers.rs
@@ -968,6 +968,7 @@ impl<'mir, 'tcx> MiriMachine<'mir, 'tcx> {
         self.threads.active_thread_ref().top_user_relevant_frame()
     }
 
+    /// This is the source of truth for the `is_user_relevant` flag in our `FrameExtra`.
     pub fn is_user_relevant(&self, frame: &Frame<'mir, 'tcx, Provenance>) -> bool {
         let def_id = frame.instance.def_id();
         (def_id.is_local() || self.local_crates.contains(&def_id.krate))

Original file line number	Diff line number	Diff line change
`@@ -968,6 +968,7 @@ impl<'mir, 'tcx> MiriMachine<'mir, 'tcx> {`
`968`	`968`	`self.threads.active_thread_ref().top_user_relevant_frame()`
`969`	`969`	`}`
`970`	`970`
	`971`	+ /// This is the source of truth for the `is_user_relevant` flag in our `FrameExtra`.
`971`	`972`	`pub fn is_user_relevant(&self, frame: &Frame<'mir, 'tcx, Provenance>) -> bool {`
`972`	`973`	`let def_id = frame.instance.def_id();`
`973`	`974`	`(def_id.is_local() \|\| self.local_crates.contains(&def_id.krate))`