Skip to content

Commit 8f64080

Browse files
committed
[mlir][ArmSME] Switch to using custom documentation
This patch introduces a hand-written markdown file that documents the ArmSME dialect. ATM, it simply includes the auto-generated documentation for the custom and for the LLVM intrinsic ops. Doing this by hand allows us to clarify the document by splitting it into meaningful categories. Moving forward, this change will allow us to improve/expand the documentation for the ArmSME dialect (and, in general, about supporting SME in MLIR). Depends on #67985
1 parent 8d6d4f8 commit 8f64080

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

mlir/docs/Dialects/ArmSME.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 'ArmSME' Dialect
2+
3+
Basic dialect to target Arm SME architectures This dialect contains the
4+
definitions necessary to target Arm SME scalable matrix operations.
5+
6+
## References
7+
* https://developer.arm.com/documentation/ddi0616
8+
* https://developer.arm.com/documentation/ddi0602/2023-03/SME-Instructions
9+
10+
## Operations
11+
12+
[include "Dialects/ArmSMEOps.md"]
13+
14+
## Operations for LLVM IR Intrinsics
15+
16+
[include "Dialects/ArmSMEIntrinsicOps.md"]

mlir/include/mlir/Dialect/ArmSME/IR/CMakeLists.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
add_mlir_dialect(ArmSME arm_sme ArmSME)
2-
add_mlir_doc(ArmSME ArmSME Dialects/ -gen-dialect-doc -dialect=arm_sme)
32

43
# Generate declarations and definitions of ArmSME Ops
54
set(LLVM_TARGET_DEFINITIONS ArmSMEOps.td)
@@ -22,3 +21,7 @@ mlir_tablegen(ArmSMEIntrinsicOps.h.inc -gen-op-decls)
2221
mlir_tablegen(ArmSMEIntrinsicOps.cpp.inc -gen-op-defs)
2322
mlir_tablegen(ArmSMEIntrinsicConversions.inc -gen-llvmir-conversions)
2423
add_public_tablegen_target(MLIRArmSMEIntrinsicOpsIncGen)
24+
25+
# Generate the docs
26+
add_mlir_doc(ArmSMEOps ArmSMEOps Dialects/ -gen-op-doc)
27+
add_mlir_doc(ArmSMEIntrinsicOps ArmSMEIntrinsicOps Dialects/ -gen-op-doc)

0 commit comments

Comments
 (0)