Skip to content

[mlir][docs] Fix broken docs #82308

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
Feb 21, 2024
Merged

[mlir][docs] Fix broken docs #82308

merged 1 commit into from
Feb 21, 2024

Conversation

sott0n
Copy link
Contributor

@sott0n sott0n commented Feb 20, 2024

  • Fixed OpenACC's spec link format
  • Add missed OpenACCPasses.md into Passes.md
  • Add missed MyExtensionCh4.md into Ch4.md of tutorial of transform

@llvmbot
Copy link
Member

llvmbot commented Feb 20, 2024

@llvm/pr-subscribers-mlir-openacc

@llvm/pr-subscribers-mlir

Author: Kohei Yamaguchi (sott0n)

Changes
  • Fixed OpenACC's spec link format
  • Add missed OpenACCPasses.md into Passes.md
  • Add missed MyExtensionCh4.md into Ch4.md of tutorial of transform

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

3 Files Affected:

  • (modified) mlir/docs/Dialects/OpenACCDialect.md (+3-2)
  • (modified) mlir/docs/Passes.md (+4)
  • (modified) mlir/docs/Tutorials/transform/Ch4.md (+4)
diff --git a/mlir/docs/Dialects/OpenACCDialect.md b/mlir/docs/Dialects/OpenACCDialect.md
index ce0f1c3bbbba82..2f1bb194a167d4 100755
--- a/mlir/docs/Dialects/OpenACCDialect.md
+++ b/mlir/docs/Dialects/OpenACCDialect.md
@@ -9,8 +9,8 @@ by giving the compiler the freedom of how to parallelize for specific
 architectures. OpenACC also provides the ability to optimize the
 parallelism through increasingly more prescriptive clauses.
 
-This dialect models the constructs from the [OpenACC 3.3 specification]
-(https://www.openacc.org/sites/default/files/inline-images/Specification/OpenACC-3.3-final.pdf)
+This dialect models the constructs from the 
+[OpenACC 3.3 specification](https://www.openacc.org/sites/default/files/inline-images/Specification/OpenACC-3.3-final.pdf)
 
 This document describes the design of the OpenACC dialect in MLIR. It
 lists and explains design goals and design choices along with their
@@ -451,3 +451,4 @@ dominates another.
 ## Operations TOC
 
 [include "Dialects/OpenACCDialectOps.md"]
+
diff --git a/mlir/docs/Passes.md b/mlir/docs/Passes.md
index ee7d47cc022723..84e6664436d7b3 100644
--- a/mlir/docs/Passes.md
+++ b/mlir/docs/Passes.md
@@ -16,6 +16,10 @@ This document describes the available MLIR passes and their contracts.
 
 [include "ConversionPasses.md"]
 
+## 'acc' Dialect Passes
+
+[include "OpenACCPasses.md"]
+
 ## 'affine' Dialect Passes
 
 [include "AffinePasses.md"]
diff --git a/mlir/docs/Tutorials/transform/Ch4.md b/mlir/docs/Tutorials/transform/Ch4.md
index ad5221c6f6ccaf..c3159eb991d1e9 100644
--- a/mlir/docs/Tutorials/transform/Ch4.md
+++ b/mlir/docs/Tutorials/transform/Ch4.md
@@ -579,3 +579,7 @@ accessed dimensions as other parameters that can be compared with each other to
 ensure the subscripts are `m,k` for LHS, `k,n` for RHS and `m,n` for the
 init/result given the `m,n,k` notation for loops.
 
+## Appendix: Autogenerated Documentation
+
+[include "Tutorials/transform/MyExtensionCh4.md"]
+

@sott0n
Copy link
Contributor Author

sott0n commented Feb 21, 2024

@joker-eph Thanks for your review, could you land it?

Copy link
Contributor

@razvanlupusoru razvanlupusoru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@ftynse ftynse merged commit 0c13a89 into llvm:main Feb 21, 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.

5 participants