[Mlir-commits] [mlir] d8c18e4 - [mlir] fix documentation includes

[Alex Zinenko]

Author: Alex Zinenko
Date: 2023-05-31T08:58:42Z
New Revision: d8c18e422baa637b0208833be4a4b4ce4b06f212

URL: https://github.com/llvm/llvm-project/commit/d8c18e422baa637b0208833be4a4b4ce4b06f212
DIFF: https://github.com/llvm/llvm-project/commit/d8c18e422baa637b0208833be4a4b4ce4b06f212.diff

LOG: [mlir] fix documentation includes

Added: 
    

Modified: 
    mlir/docs/Passes.md
    mlir/docs/Tutorials/transform/Ch2.md
    mlir/docs/Tutorials/transform/Ch3.md
    mlir/docs/Tutorials/transform/_index.md
    mlir/examples/transform/Ch2/include/CMakeLists.txt
    mlir/examples/transform/Ch3/include/CMakeLists.txt

Removed: 
    


################################################################################
diff  --git a/mlir/docs/Passes.md b/mlir/docs/Passes.md
index 58e8136b989fd..2485840480f51 100644
--- a/mlir/docs/Passes.md
+++ b/mlir/docs/Passes.md
@@ -28,6 +28,10 @@ This document describes the available MLIR passes and their contracts.
 
 [include "ArithPasses.md"]
 
+## 'arm\_sme' Dialect Passes
+
+[include "ArmSMEPasses.md"]
+
 ## 'async' Dialect Passes
 
 [include "AsyncPasses.md"]

diff  --git a/mlir/docs/Tutorials/transform/Ch2.md b/mlir/docs/Tutorials/transform/Ch2.md
index 2649be0b09ef3..e3d6cf738ffc1 100644
--- a/mlir/docs/Tutorials/transform/Ch2.md
+++ b/mlir/docs/Tutorials/transform/Ch2.md
@@ -325,3 +325,7 @@ transform.sequence failures(propagate) {
   transform.yield
 }
 ```
+
+## Appendix: Autogenerated Documentation
+
+[include "MyExtensionCh2.md"]

diff  --git a/mlir/docs/Tutorials/transform/Ch3.md b/mlir/docs/Tutorials/transform/Ch3.md
index 4a8c17a73e59f..64837a6f005f4 100644
--- a/mlir/docs/Tutorials/transform/Ch3.md
+++ b/mlir/docs/Tutorials/transform/Ch3.md
@@ -280,4 +280,7 @@ def CallToOp : Op<Transform_Dialect, "my.call_to_op",
 }
 ```
 
+## Appendix: Autogenerated Documentation
+
+[include "MyExtensionCh3.md"]
 

diff  --git a/mlir/docs/Tutorials/transform/_index.md b/mlir/docs/Tutorials/transform/_index.md
index bb09cdee212b8..821177aa6cbda 100644
--- a/mlir/docs/Tutorials/transform/_index.md
+++ b/mlir/docs/Tutorials/transform/_index.md
@@ -15,7 +15,7 @@ demonstration of three use scenarios:
   code to work with the transform dialect infrastructure.
 - Setting up and using the transform dialect infrastructure in a downstream
   out-of-tree project with custom dialects, transformations and passes.
-  
+
 After following the tutorial, one will be able to apply the transform dialect in
 their work and extend it when necessary. Basic familiarity with MLIR is a
 prerequisite. See [Toy tutorial](../Toy) for introduction to MLIR.

diff  --git a/mlir/examples/transform/Ch2/include/CMakeLists.txt b/mlir/examples/transform/Ch2/include/CMakeLists.txt
index fcdc68a160f4b..bb8935153e768 100644
--- a/mlir/examples/transform/Ch2/include/CMakeLists.txt
+++ b/mlir/examples/transform/Ch2/include/CMakeLists.txt
@@ -8,5 +8,6 @@ mlir_tablegen(MyExtension.cpp.inc -gen-op-defs)
 # Add a CMakeTarget we can depend on to ensure the generation happens before the compilation.
 add_public_tablegen_target(MyExtensionCh2IncGen)
 
-# Don't forget to generate the documentation, this will produce a MyExtension.md under Dialects.
-add_mlir_doc(MyExtension MyExtensionCh2 Dialects/ -gen-op-doc)
+# Don't forget to generate the documentation, this will produce a
+# MyExtensionCh2.md under Tutorials/transform
+add_mlir_doc(MyExtension MyExtensionCh2 Tutorials/transform/ -gen-op-doc)

diff  --git a/mlir/examples/transform/Ch3/include/CMakeLists.txt b/mlir/examples/transform/Ch3/include/CMakeLists.txt
index 32ec779ec3e1f..59bd3be30538b 100644
--- a/mlir/examples/transform/Ch3/include/CMakeLists.txt
+++ b/mlir/examples/transform/Ch3/include/CMakeLists.txt
@@ -15,5 +15,6 @@ mlir_tablegen(MyExtensionTypes.cpp.inc -gen-typedef-defs)
 # Add a CMakeTarget we can depend on to ensure the generation happens before the compilation.
 add_public_tablegen_target(MyExtensionCh3IncGen)
 
-# Don't forget to generate the documentation, this will produce a MyExtension.md under Dialects.
-add_mlir_doc(MyExtension MyExtensionCh3 Dialects/ -gen-op-doc)
+# Don't forget to generate the documentation, this will produce a
+# MyExtensionCh3.md under Tutorials/transform
+add_mlir_doc(MyExtension MyExtensionCh3 Tutorials/transform/ -gen-op-doc)