From fb68292b24e5bd14c04d820fd352722cc060c789 Mon Sep 17 00:00:00 2001
From: Ben Kimock <kimockb@gmail.com>
Date: Mon, 10 Apr 2023 22:38:29 -0400
Subject: [PATCH] Improve doc comment of AllocExtra's backtrace

Co-authored-by: Ralf Jung <post@ralfj.de>
---
 src/tools/miri/src/machine.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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>>>,
 }