about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbjorn3 <bjorn3@users.noreply.github.com>2021-08-31 15:06:59 +0200
committerbjorn3 <bjorn3@users.noreply.github.com>2021-09-02 12:29:12 +0200
commit74c7f1267b2afe17332ba3aa6b00eb9452404cf3 (patch)
tree419f1f98d1a579ff9b7af9a884eb20150fa2217b
parentb86a2ee03686905afb7ae90fd092af037da5906d (diff)
downloadrust-74c7f1267b2afe17332ba3aa6b00eb9452404cf3.tar.gz
rust-74c7f1267b2afe17332ba3aa6b00eb9452404cf3.zip
Add explanation for ctfe_backtrace lock
-rw-r--r--compiler/rustc_session/src/session.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/compiler/rustc_session/src/session.rs b/compiler/rustc_session/src/session.rs
index f29275bffc4..0f7db69fefe 100644
--- a/compiler/rustc_session/src/session.rs
+++ b/compiler/rustc_session/src/session.rs
@@ -190,6 +190,9 @@ pub struct Session {
     /// Tracks the current behavior of the CTFE engine when an error occurs.
     /// Options range from returning the error without a backtrace to returning an error
     /// and immediately printing the backtrace to stderr.
+    /// The `Lock` is only used by miri to allow setting `ctfe_backtrace` after analysis when
+    /// `MIRI_BACKTRACE` is set. This makes it only apply to miri's errors and not to all CTFE
+    /// errors.
     pub ctfe_backtrace: Lock<CtfeBacktrace>,
 
     /// This tracks where `-Zunleash-the-miri-inside-of-you` was used to get around a