[Mlir-commits] [mlir] [mlir][irdl] update documentation (PR #103394)

[Timothy Hoffman]

https://github.com/tim-hoffman created https://github.com/llvm/llvm-project/pull/103394

fixes #103300 

>From 65c171fa293e332cf731f08d0d4848bb8980c634 Mon Sep 17 00:00:00 2001
From: Tim Hoffman <timothy.hoffman at veridise.com>
Date: Tue, 13 Aug 2024 13:49:30 -0500
Subject: [PATCH] [mlir][irdl] update documentation

---
 mlir/include/mlir/Dialect/IRDL/IR/IRDL.td     | 10 +++++-----
 mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td  | 20 +++++++++----------
 .../include/mlir/Dialect/IRDL/IR/IRDLTypes.td |  4 ++--
 3 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
index b9177f8c594f9c..e822969fc575eb 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
@@ -37,17 +37,17 @@ def IRDL_Dialect : Dialect {
     ```mlir
     irdl.dialect @cmath {
       irdl.type @complex {
-        %0 = irdl.is_type : f32
-        %1 = irdl.is_type : f64
+        %0 = irdl.is f32
+        %1 = irdl.is f64
         %2 = irdl.any_of(%0, %1)
         irdl.parameters(%2)
       }
 
       irdl.operation @mul {
-        %0 = irdl.is_type : f32
-        %1 = irdl.is_type : f64
+        %0 = irdl.is f32
+        %1 = irdl.is f64
         %2 = irdl.any_of(%0, %1)
-        %3 = irdl.parametric_type : "cmath.complex"<%2>
+        %3 = irdl.parametric @cmath::@complex<%2>
         irdl.operands(%3, %3)
         irdl.results(%3)
       }
diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
index d2765dec420ac2..89a5b5b58439ba 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
@@ -182,7 +182,7 @@ def IRDL_OperationOp : IRDL_Op<"operation",
 
       irdl.operation @norm {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.results(%0)
         irdl.operands(%1)
       }
@@ -216,7 +216,7 @@ def IRDL_OperandsOp : IRDL_Op<"operands", [HasParent<"OperationOp">]> {
 
       irdl.operation @mul {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.results(%1)
         irdl.operands(%1, %1)
       }
@@ -262,7 +262,7 @@ def IRDL_ResultsOp : IRDL_Op<"results", [HasParent<"OperationOp">]> {
 
       irdl.operation @get_values {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.results(%0, %0)
         irdl.operands(%1)
       }
@@ -472,7 +472,7 @@ def IRDL_BaseOp : IRDL_ConstraintOp<"base",
       }
 
       irdl.type @complex_wrapper {
-        %0 = irdl.base @complex
+        %0 = irdl.base @cmath::@complex
         irdl.parameters(%0)
       }
     }
@@ -521,7 +521,7 @@ def IRDL_ParametricOp : IRDL_ConstraintOp<"parametric",
 
       irdl.operation @norm {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.operands(%1)
         irdl.results(%0)
       }
@@ -574,8 +574,8 @@ def IRDL_AnyOfOp : IRDL_ConstraintOp<"any_of",
     Example:
 
     ```mlir
-    irdl.dialect cmath {
-      irdl.type complex {
+    irdl.dialect @cmath {
+      irdl.type @complex {
         %0 = irdl.is i32
         %1 = irdl.is i64
         %2 = irdl.is f32
@@ -588,7 +588,7 @@ def IRDL_AnyOfOp : IRDL_ConstraintOp<"any_of",
 
     The above program defines a type `complex` inside the dialect `cmath` that
     can have a single type parameter that can be either `i32`, `i64`, `f32` or
-    `f32`.
+    `f64`.
   }];
 
   let arguments = (ins Variadic<IRDL_AttributeType>:$args);
@@ -607,8 +607,8 @@ def IRDL_AllOfOp : IRDL_ConstraintOp<"all_of",
     Example:
 
     ```mlir
-    irdl.dialect cmath {
-      irdl.type complex_f32 {
+    irdl.dialect @cmath {
+      irdl.type @complex_f32 {
         %0 = irdl.is i32
         %1 = irdl.is f32
         %2 = irdl.any_of(%0, %1) // is 32-bit
diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
index 2fcf1b41ffd78f..9b17bf23df1825 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
@@ -32,13 +32,13 @@ def IRDL_AttributeType : IRDL_Type<"Attribute", "attribute"> {
     Example:
 
     ```mlir
-    irdl.dialect cmath {
+    irdl.dialect @cmath {
 
       irdl.type @complex { /* ... */ }
 
       irdl.operation @norm {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.operands(%1)
         irdl.results(%0)
       }