about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBen Kimock <kimockb@gmail.com>2022-11-22 10:19:29 -0500
committerGitHub <noreply@github.com>2022-11-22 10:19:29 -0500
commit1ca3c293b2c196e02e188faeddf0a0d776d39fd6 (patch)
tree5a78a2da668704cea04f60dd6fb3273abb8107b4
parent23270ae8d39ae15020476f92ec9f4e05960f5de0 (diff)
downloadrust-1ca3c293b2c196e02e188faeddf0a0d776d39fd6.tar.gz
rust-1ca3c293b2c196e02e188faeddf0a0d776d39fd6.zip
Document is_user_relevant
Co-authored-by: Ralf Jung <post@ralfj.de>
-rw-r--r--src/tools/miri/src/helpers.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/tools/miri/src/helpers.rs b/src/tools/miri/src/helpers.rs
index 958ed50496b..70971cdc20e 100644
--- 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))