[MLIR][NVVM] Doc fixes #168716
[MLIR][NVVM] Doc fixes #168716
Conversation
|
@llvm/pr-subscribers-mlir @llvm/pr-subscribers-mlir-llvm Author: Guray Ozen (grypp) ChangesFull diff: https://github.com/llvm/llvm-project/pull/168716.diff 2 Files Affected:
diff --git a/mlir/docs/Dialects/NVVMDialect.md b/mlir/docs/Dialects/NVVMDialect.md
index b50980258593d..12ec2b3fd989e 100644
--- a/mlir/docs/Dialects/NVVMDialect.md
+++ b/mlir/docs/Dialects/NVVMDialect.md
@@ -1,4 +1,4 @@
-# NVVM Dialect
+# 'nvvm' Dialect
The NVVM dialect is MLIR's LLVM-IR-based, NVIDIA-specific backend dialect. It
models NVVM intrinsics and public ISA functionality and introduces NVIDIA
@@ -93,8 +93,3 @@ of an operation is that used in LLVM IR prefixed with "`nvvm.`".
[include "Dialects/NVVMOps.md"]
-
-## Op Interfaces
-
-[include "Dialects/NVVMRequiresSMTraits.md"]
-
diff --git a/mlir/include/mlir/Dialect/LLVMIR/CMakeLists.txt b/mlir/include/mlir/Dialect/LLVMIR/CMakeLists.txt
index c301e0b40e8fe..25b56cc9e5594 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/CMakeLists.txt
+++ b/mlir/include/mlir/Dialect/LLVMIR/CMakeLists.txt
@@ -63,7 +63,7 @@ mlir_tablegen(NVVMRequiresSMTraits.cpp.inc -gen-op-interface-defs)
add_mlir_dialect_tablegen_target(MLIRNVVMRequiresSMTraitsIncGen)
add_mlir_dialect(NVVMOps nvvm)
-add_mlir_doc(NVVMOps NVVMDialect Dialects/ -gen-dialect-doc -dialect=nvvm)
+add_mlir_doc(NVVMOps NVVMOps Dialects/ -gen-op-doc)
set(LLVM_TARGET_DEFINITIONS NVVMOps.td)
mlir_tablegen(NVVMConversions.inc -gen-llvmir-conversions)
mlir_tablegen(NVVMFromLLVMIRConversions.inc -gen-intr-from-llvmir-conversions)
|
|
|
||
| add_mlir_dialect(NVVMOps nvvm) | ||
| add_mlir_doc(NVVMOps NVVMDialect Dialects/ -gen-dialect-doc -dialect=nvvm) | ||
| add_mlir_doc(NVVMOps NVVMOps Dialects/ -gen-op-doc) |
There was a problem hiding this comment.
so, this gen-op-doc is a new way of configuring? (instead of what we had earlier)
I looked into the public Docs page, and it seems we cannot get to the actual docs of the Ops.
I believe this PR will address it..?
There was a problem hiding this comment.
This way should generate doc for only ops. Previously doc was generated for the dialect, now we write the dialect manually, but we still need auto-generated docs for the OPs.
🐧 Linux x64 Test Results
|
|
|
||
| ## Op Interfaces | ||
|
|
||
| [include "Dialects/NVVMRequiresSMTraits.md"] |
There was a problem hiding this comment.
@grypp Why did we remove the SMTraits doc file? Should it be included somewhere else?
There was a problem hiding this comment.
I don't think we generate any doc for that interface. We have ptx builder interface. I can put new PR and generate doc for them
schwarzschild-radius
left a comment
schwarzschild-radius
left a comment
There was a problem hiding this comment.
Other than a clarification on the SMTraits file, the change looks good to me. Thanks!
4 participants
No description provided.