From fb579435a5d25d947df90ddb72932c8f901ac77e Mon Sep 17 00:00:00 2001 From: pierwill <19642016+pierwill@users.noreply.github.com> Date: Wed, 6 Jul 2022 12:48:19 -0500 Subject: [PATCH] docs: Add overview of `rustc_middle::mir::TerminatorKind` --- compiler/rustc_middle/src/mir/syntax.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/compiler/rustc_middle/src/mir/syntax.rs b/compiler/rustc_middle/src/mir/syntax.rs index 5d4f3ea9e4c..499fd84f1b8 100644 --- a/compiler/rustc_middle/src/mir/syntax.rs +++ b/compiler/rustc_middle/src/mir/syntax.rs @@ -396,6 +396,8 @@ pub struct CopyNonOverlapping<'tcx> { /////////////////////////////////////////////////////////////////////////// // Terminators +/// The various kinds of terminators, representing ways of exiting from a basic block. +/// /// A note on unwinding: Panics may occur during the execution of some terminators. Depending on the /// `-C panic` flag, this may either cause the program to abort or the call stack to unwind. Such /// terminators have a `cleanup: Option` field on them. If stack unwinding occurs, then