[Mlir-commits] [mlir] [mlir][cf] fix cf dialect's operations' summary (PR #101494)

Andrey Timonin llvmlistbot at llvm.org
Thu Aug 1 07:56:20 PDT 2024


https://github.com/EtoAndruwa created https://github.com/llvm/llvm-project/pull/101494

Due to the [ODS](https://mlir.llvm.org/docs/DefiningDialects/Operations/#operation-arguments) the summary of the operation in the TableGen must start with the capital letter. 

>From the text:
`The summary should be short and concise. It should be a one-liner starting with a capital letter and without trailing punctuation. Put expanded explanation in the description.`

>From 29b4b28c6e1d426753823b18347a563de355474b Mon Sep 17 00:00:00 2001
From: EtoAndruwa <timonina1909 at gmail.com>
Date: Thu, 1 Aug 2024 17:47:33 +0300
Subject: [PATCH] [mlir][cf] fix cf dialect's operations' summary

---
 mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
index 3bdbfb0fedb9c..48f12b46a57f1 100644
--- a/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
+++ b/mlir/include/mlir/Dialect/ControlFlow/IR/ControlFlowOps.td
@@ -68,7 +68,7 @@ def BranchOp : CF_Op<"br", [
     DeclareOpInterfaceMethods<BranchOpInterface, ["getSuccessorForOperands"]>,
     Pure, Terminator
   ]> {
-  let summary = "branch operation";
+  let summary = "Branch operation";
   let description = [{
     The `cf.br` operation represents a direct branch operation to a given
     block. The operands of this operation are forwarded to the successor block,
@@ -116,7 +116,7 @@ def CondBranchOp : CF_Op<"cond_br",
     [AttrSizedOperandSegments,
      DeclareOpInterfaceMethods<BranchOpInterface, ["getSuccessorForOperands"]>,
      Pure, Terminator]> {
-  let summary = "conditional branch operation";
+  let summary = "Conditional branch operation";
   let description = [{
     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
@@ -231,7 +231,7 @@ def SwitchOp : CF_Op<"switch",
     [AttrSizedOperandSegments,
      DeclareOpInterfaceMethods<BranchOpInterface, ["getSuccessorForOperands"]>,
      Pure, Terminator]> {
-  let summary = "switch operation";
+  let summary = "Switch operation";
   let description = [{
     The `cf.switch` terminator operation represents a switch on a signless integer
     value. If the flag matches one of the specified cases, then the



More information about the Mlir-commits mailing list