Skip to content

[MLIR][Linalg] Fix unclosed code block which broke generated docs - NFC #115763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

rolfmorel
Copy link
Contributor

#115319 added a tablegen description for an op (MatmulOp) but missed closing one of the code blocks in the description. As a result the generated docs broke, i.e. https://mlir.llvm.org/docs/Dialects/Linalg was broken after this code block.

@llvmbot
Copy link
Member

llvmbot commented Nov 11, 2024

@llvm/pr-subscribers-mlir-linalg

@llvm/pr-subscribers-mlir

Author: Rolf Morel (rolfmorel)

Changes

#115319 added a tablegen description for an op (MatmulOp) but missed closing one of the code blocks in the description. As a result the generated docs broke, i.e. https://mlir.llvm.org/docs/Dialects/Linalg was broken after this code block.


Full diff: https://github.com/llvm/llvm-project/pull/115763.diff

1 Files Affected:

  • (modified) mlir/include/mlir/Dialect/Linalg/IR/LinalgStructuredOps.td (+11-10)
diff --git a/mlir/include/mlir/Dialect/Linalg/IR/LinalgStructuredOps.td b/mlir/include/mlir/Dialect/Linalg/IR/LinalgStructuredOps.td
index 2b47414ff5e924..e578f4b956ef5e 100644
--- a/mlir/include/mlir/Dialect/Linalg/IR/LinalgStructuredOps.td
+++ b/mlir/include/mlir/Dialect/Linalg/IR/LinalgStructuredOps.td
@@ -561,7 +561,7 @@ def BroadcastOp : LinalgStructuredBase_Op<"broadcast", [
 def MatmulOp : LinalgStructuredBase_Op<"matmul", [
                AttrSizedOperandSegments,
                LinalgContractionOpInterface]> {
-    
+
   let summary = [{
     Performs a matrix multiplication of two 2D inputs without broadcast or transpose.
     }];
@@ -593,16 +593,17 @@ def MatmulOp : LinalgStructuredBase_Op<"matmul", [
                   ]
                   ins(%arg0, %arg1 : memref<3xf32>, memref<5x7xf32>)
                   outs(%arg2: memref<3x7xf32>)
-     ```
+    ```
 
-     Example Broadcast and transpose:
-     ```
-     linalg.matmul indexing_maps = [
-                       affine_map<(d0, d1, d2) -> (d2, d0)>, // transpose
-                       affine_map<(d0, d1, d2) -> (d2)>,     // broadcast
-                       affine_map<(d0, d1, d2) -> (d0, d1)>
-                     ]
-                     ins(%arg0, %arg1 : memref<5x3xf32>, memref<7xf32>) outs(%arg2: memref<3x7xf32>)
+    Example Broadcast and transpose:
+    ```
+    linalg.matmul indexing_maps = [
+                      affine_map<(d0, d1, d2) -> (d2, d0)>, // transpose
+                      affine_map<(d0, d1, d2) -> (d2)>,     // broadcast
+                      affine_map<(d0, d1, d2) -> (d0, d1)>
+                    ]
+                    ins(%arg0, %arg1 : memref<5x3xf32>, memref<7xf32>) outs(%arg2: memref<3x7xf32>)
+    ```
     }];
 
     let arguments = (ins

@rolfmorel rolfmorel requested a review from adam-smnk November 11, 2024 20:36
@rolfmorel rolfmorel merged commit c02b8a0 into llvm:main Nov 11, 2024
8 of 10 checks passed
@rolfmorel
Copy link
Contributor Author

Thanks @MaheshRavishankar !

Groverkss added a commit to Groverkss/llvm-project that referenced this pull request Nov 15, 2024
Groverkss added a commit to iree-org/llvm-project that referenced this pull request Nov 15, 2024
Groverkss pushed a commit to iree-org/llvm-project that referenced this pull request Nov 15, 2024
…FC (llvm#115763)

llvm#115319 added a tablegen description for an op (MatmulOp) but missed
closing one of the code blocks in the description. As a result the
generated docs broke, i.e. https://mlir.llvm.org/docs/Dialects/Linalg
was broken after this code block.
Groverkss added a commit to iree-org/llvm-project that referenced this pull request Nov 15, 2024
Groverkss added a commit to iree-org/llvm-project that referenced this pull request Nov 15, 2024
Groverkss added a commit to iree-org/llvm-project that referenced this pull request Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants