about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2022-07-06 20:43:28 +0200
committerGitHub <noreply@github.com>2022-07-06 20:43:28 +0200
commit47de8e96f89e87cedbafcac7dfd65fc7cd23eb74 (patch)
treef4537b8936071da829cee45d41710929e9704ed7
parente8ba11362b67fd9450025f0ad443f6669018b12a (diff)
parentfb579435a5d25d947df90ddb72932c8f901ac77e (diff)
downloadrust-47de8e96f89e87cedbafcac7dfd65fc7cd23eb74.tar.gz
rust-47de8e96f89e87cedbafcac7dfd65fc7cd23eb74.zip
Rollup merge of #98983 - pierwill:patch-3, r=RalfJung
docs: Add overview of `rustc_middle::mir::TerminatorKind`
-rw-r--r--compiler/rustc_middle/src/mir/syntax.rs2
1 files changed, 2 insertions, 0 deletions
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<BasicBlock>` field on them. If stack unwinding occurs, then