[Mlir-commits] [mlir] d8b985c - [mlir][cf] fix 'switch', 'assert' and 'cond_br' operations' description (#101319)

[llvmlistbot at llvm.org]

Author: Andrey Timonin
Date: 2024-07-31T14:41:31+02:00
New Revision: d8b985c9490664f7ec923e59cf6c603d998179ae

URL: https://github.com/llvm/llvm-project/commit/d8b985c9490664f7ec923e59cf6c603d998179ae
DIFF: https://github.com/llvm/llvm-project/commit/d8b985c9490664f7ec923e59cf6c603d998179ae.diff

LOG: [mlir][cf] fix 'switch', 'assert' and 'cond_br' operations' description (#101319)

Added: 
    

Modified: 
    mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
index 181bc5a2d07fa..3bdbfb0fedb9c 100644
--- a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
+++ b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
@@ -50,7 +50,7 @@ def AssertOp : CF_Op<"assert",
     Example:
 
     ```mlir
-    assert %b, "Expected ... to be true"
+    cf.assert %b, "Expected ... to be true"
     ```
   }];
 
@@ -118,7 +118,7 @@ def CondBranchOp : CF_Op<"cond_br",
      Pure, Terminator]> {
   let summary = "conditional branch operation";
   let description = [{
-    The `cond_br` terminator operation represents a conditional branch on a
+    The `cf.cond_br` terminator operation represents a conditional branch on a
     boolean (1-bit integer) value. If the bit is set, then the first destination
     is jumped to; if it is false, the second destination is chosen. The count
     and types of operands must align with the arguments in the corresponding
@@ -136,7 +136,7 @@ def CondBranchOp : CF_Op<"cond_br",
     ```mlir
     func.func @select(%a: i32, %b: i32, %flag: i1) -> i32 {
       // Both targets are the same, operands 
diff er
-      cond_br %flag, ^bb1(%a : i32), ^bb1(%b : i32)
+      cf.cond_br %flag, ^bb1(%a : i32), ^bb1(%b : i32)
 
     ^bb1(%x : i32) :
       return %x : i32
@@ -233,7 +233,7 @@ def SwitchOp : CF_Op<"switch",
      Pure, Terminator]> {
   let summary = "switch operation";
   let description = [{
-    The `switch` terminator operation represents a switch on a signless integer
+    The `cf.switch` terminator operation represents a switch on a signless integer
     value. If the flag matches one of the specified cases, then the
     corresponding destination is jumped to. If the flag does not match any of
     the cases, the default destination is jumped to. The count and types of
@@ -242,7 +242,7 @@ def SwitchOp : CF_Op<"switch",
     Example:
 
     ```mlir
-    switch %flag : i32, [
+    cf.switch %flag : i32, [
       default: ^bb1(%a : i32),
       42: ^bb1(%b : i32),
       43: ^bb3(%c : i32)