about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBen Kimock <kimockb@gmail.com>2023-04-10 22:38:29 -0400
committerBen Kimock <kimockb@gmail.com>2023-04-16 10:00:02 -0400
commitfb68292b24e5bd14c04d820fd352722cc060c789 (patch)
tree20249df462eb40dcd7721c05ba598a1fc08f6bf3
parentcbc7f94f113f7ae97db7e04b7f71b753c8349435 (diff)
downloadrust-fb68292b24e5bd14c04d820fd352722cc060c789.tar.gz
rust-fb68292b24e5bd14c04d820fd352722cc060c789.zip
Improve doc comment of AllocExtra's backtrace
Co-authored-by: Ralf Jung <post@ralfj.de>
-rw-r--r--src/tools/miri/src/machine.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/tools/miri/src/machine.rs b/src/tools/miri/src/machine.rs
index 37f54a4a5bd..ecb3e13dd54 100644
--- a/src/tools/miri/src/machine.rs
+++ b/src/tools/miri/src/machine.rs
@@ -264,7 +264,8 @@ pub struct AllocExtra<'tcx> {
     pub weak_memory: Option<weak_memory::AllocState>,
     /// A backtrace to where this allocation was allocated.
     /// As this is recorded for leak reports, it only exists
-    /// if this allocation is leakable.
+    /// if this allocation is leakable. The backtrace is not
+    /// pruned yet; that should be done before printing it.
     pub backtrace: Option<Vec<FrameInfo<'tcx>>>,
 }