Rollup merge of #106805 - madsravn:master, r=compiler-errors

[rust.git] / compiler / rustc_middle / src / mir / syntax.rs

diff --git a/compiler/rustc_middle/src/mir/syntax.rs b/compiler/rustc_middle/src/mir/syntax.rs
index faf903a59490164f42733f41a91289eaf9aecf8d..549bc65d6d79c7858a144fd038c107f1a07d85e5 100644 (file)
--- a/compiler/rustc_middle/src/mir/syntax.rs
+++ b/compiler/rustc_middle/src/mir/syntax.rs
@@ -286,10 +286,7 @@ pub enum StatementKind<'tcx> {
     /// This is permitted for both generators and ADTs. This does not necessarily write to the
     /// entire place; instead, it writes to the minimum set of bytes as required by the layout for
     /// the type.
-    SetDiscriminant {
-        place: Box<Place<'tcx>>,
-        variant_index: VariantIdx,
-    },
+    SetDiscriminant { place: Box<Place<'tcx>>, variant_index: VariantIdx },
 
     /// Deinitializes the place.
     ///
@@ -358,6 +355,10 @@ pub enum StatementKind<'tcx> {
     /// This avoids adding a new block and a terminator for simple intrinsics.
     Intrinsic(Box<NonDivergingIntrinsic<'tcx>>),
 
+    /// Instructs the const eval interpreter to increment a counter; this counter is used to track
+    /// how many steps the interpreter has taken. It is used to prevent the user from writing const
+    /// code that runs for too long or infinitely. Other than in the const eval interpreter, this
+    /// is a no-op.
     ConstEvalCounter,
 
     /// No-op. Useful for deleting instructions without affecting statement indices.