Add comment to cleanup_kinds

tmiasko · tmiasko · commit 836ef6162dfe · 2023-01-10T09:53:18.000+01:00
based on the original commit message 1ae7ae0
diff --git a/compiler/rustc_codegen_ssa/src/mir/analyze.rs b/compiler/rustc_codegen_ssa/src/mir/analyze.rs
@@ -261,6 +261,9 @@ impl CleanupKind {
     }
 }
 
+/// MSVC requires unwinding code to be split to a tree of *funclets*, where each funclet can only
+/// branch to itself or to its parent. Luckily, the code we generates matches this pattern.
+/// Recover that structure in an analyze pass.
 pub fn cleanup_kinds(mir: &mir::Body<'_>) -> IndexVec<mir::BasicBlock, CleanupKind> {
     fn discover_masters<'tcx>(
         result: &mut IndexVec<mir::BasicBlock, CleanupKind>,

Original file line number	Diff line number	Diff line change
`@@ -261,6 +261,9 @@ impl CleanupKind {`
`261`	`261`	`}`
`262`	`262`	`}`
`263`	`263`
	`264`	`+/// MSVC requires unwinding code to be split to a tree of funclets, where each funclet can only`
	`265`	`+/// branch to itself or to its parent. Luckily, the code we generates matches this pattern.`
	`266`	`+/// Recover that structure in an analyze pass.`
`264`	`267`	`pub fn cleanup_kinds(mir: &mir::Body<'_>) -> IndexVec<mir::BasicBlock, CleanupKind> {`
`265`	`268`	`fn discover_masters<'tcx>(`
`266`	`269`	`result: &mut IndexVec<mir::BasicBlock, CleanupKind>,`