[Mlir-commits] [mlir] [mlir][docs] Rename OpTrait to Trait in ODS doc (PR #148276)
Jian Cai
llvmlistbot at llvm.org
Fri Jul 11 11:45:50 PDT 2025
https://github.com/jcai19 created https://github.com/llvm/llvm-project/pull/148276
This makes the doc consistent with the code base.
>From 68e6c7a0cdc3744ffeeb33bd7ee765512c949676 Mon Sep 17 00:00:00 2001
From: Jian Cai <jiancai at google.com>
Date: Fri, 11 Jul 2025 11:19:25 -0700
Subject: [PATCH] [mlir][docs] Rename OpTrait to Trait in ODS doc
This makes the doc consistent with the code base.
---
mlir/docs/DefiningDialects/Operations.md | 8 ++++----
mlir/include/mlir/IR/OpBase.td | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/mlir/docs/DefiningDialects/Operations.md b/mlir/docs/DefiningDialects/Operations.md
index b3bde055f04f0..a114360f32b08 100644
--- a/mlir/docs/DefiningDialects/Operations.md
+++ b/mlir/docs/DefiningDialects/Operations.md
@@ -89,7 +89,7 @@ their semantics via a special [TableGen backend][TableGenBackend]:
help of the following constructs.
* The `Dialect` class: Operations belonging to one logical group are placed in
the same dialect. The `Dialect` class contains dialect-level information.
-* The `OpTrait` class hierarchy: They are used to specify special properties
+* The `Trait` class hierarchy: They are used to specify special properties
and constraints of the operation, including whether the operation has side
effect or whether its output has the same shape as the input.
* The `ins`/`outs` marker: These are two special markers builtin to the
@@ -434,7 +434,7 @@ various traits in the `mlir::OpTrait` namespace.
Both operation traits, [interfaces](../Interfaces.md/#utilizing-the-ods-framework),
and constraints involving multiple operands/attributes/results are provided as
the third template parameter to the `Op` class. They should be deriving from
-the `OpTrait` class. See [Constraints](#constraints) for more information.
+the `Trait` class. See [Constraints](#constraints) for more information.
### Builder methods
@@ -1353,7 +1353,7 @@ results. These constraints should be specified as the `Op` class template
parameter as described in
[Operation traits and constraints](#operation-traits-and-constraints).
-Multi-entity constraints are modeled as `PredOpTrait` (a subclass of `OpTrait`)
+Multi-entity constraints are modeled as `PredOpTrait` (a subclass of `Trait`)
in [`OpBase.td`][OpBase].A bunch of constraint primitives are provided to help
specification. See [`OpBase.td`][OpBase] for the complete list.
@@ -1364,7 +1364,7 @@ commutative or not, whether is a terminator, etc. These constraints should be
specified as the `Op` class template parameter as described in
[Operation traits and constraints](#operation-traits-and-constraints).
-Traits are modeled as `NativeOpTrait` (a subclass of `OpTrait`) in
+Traits are modeled as `NativeTrait` (a subclass of `Trait`) in
[`OpBase.td`][OpBase]. They are backed and will be translated into the
corresponding C++ `mlir::OpTrait` classes.
diff --git a/mlir/include/mlir/IR/OpBase.td b/mlir/include/mlir/IR/OpBase.td
index 43ef28624fb19..9e5fb5659a22b 100644
--- a/mlir/include/mlir/IR/OpBase.td
+++ b/mlir/include/mlir/IR/OpBase.td
@@ -22,7 +22,7 @@ include "mlir/IR/Utils.td"
include "mlir/IR/AttrTypeBase.td"
//===----------------------------------------------------------------------===//
-// OpTrait definitions
+// *OpTrait definitions
//===----------------------------------------------------------------------===//
// A trait that describes the structure of operation will be marked with
More information about the Mlir-commits
mailing list