Skip to content

[mlir][Vector] Fix doc generation #67341

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
Sep 25, 2023
Merged

[mlir][Vector] Fix doc generation #67341

merged 1 commit into from
Sep 25, 2023

Conversation

MacDue
Copy link
Member

@MacDue MacDue commented Sep 25, 2023

The format is
add_mlir_doc(<table gen file> <output md name> <output dir> <command>)

Using the Vector.td file does not work as it does not include VectorOps.td (so the docs are empty). If the output name is not VectorOps.md, the mlir-www site does not find the ops (and instead overwrites it with an empty template).

The format is
`add_mlir_doc(<table gen file> <output md name> <output dir> <command>)`

Using the Vector.td files does not work has it does not include the
VectorOps.td (so the docs are empty). If the ouput name is not
VectorOps.md, the mlir-www site does not find the ops (and instead
overwrites it with an empty template).
@llvmbot
Copy link
Member

llvmbot commented Sep 25, 2023

@llvm/pr-subscribers-mlir-vector

@llvm/pr-subscribers-mlir

Changes

The format is
add_mlir_doc(&lt;table gen file&gt; &lt;output md name&gt; &lt;output dir&gt; &lt;command&gt;)

Using the Vector.td files does not work has it does not include the VectorOps.td (so the docs are empty). If the ouput name is not VectorOps.md, the mlir-www site does not find the ops (and instead overwrites it with an empty template).


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

1 Files Affected:

  • (modified) mlir/include/mlir/Dialect/Vector/IR/CMakeLists.txt (+1-1)
diff --git a/mlir/include/mlir/Dialect/Vector/IR/CMakeLists.txt b/mlir/include/mlir/Dialect/Vector/IR/CMakeLists.txt
index 91cbb415140d002..5bbc4c6d2678b34 100644
--- a/mlir/include/mlir/Dialect/Vector/IR/CMakeLists.txt
+++ b/mlir/include/mlir/Dialect/Vector/IR/CMakeLists.txt
@@ -1,5 +1,5 @@
 add_mlir_dialect(Vector vector)
-add_mlir_doc(VectorOps Vector Dialects/ -gen-op-doc)
+add_mlir_doc(VectorOps VectorOps Dialects/ -gen-op-doc)
 
 # Add Vector operations
 set(LLVM_TARGET_DEFINITIONS VectorOps.td)

@MacDue MacDue requested a review from banach-space September 25, 2023 15:54
@nicolasvasilache
Copy link
Contributor

hmm I thought I had pushed this already .. apparently not

@MacDue MacDue merged commit c72d3ab into llvm:main Sep 25, 2023
@MacDue MacDue deleted the vector_docs branch September 25, 2023 16:55
@jpienaar
Copy link
Member

Thanks!

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.

4 participants