[mlir][NFC] Cleanup Passes documentation

[sotoshigoto]

Summary

• Fix a place of NVGPU dialect's pass
• Move a summary of -finalize-memref-to-llvm into description
• Fix broken links
• Replace back-quote dialect headers with single-quote headers for improved readability.

[bondhugula]

mlir/docs/Passes.md

87

Can you please place this in alphabetical order? Everything above is in that order.

mlir/include/mlir/Conversion/Passes.td

569

-> Finalize MemRef ... dialect conversion

mlir/include/mlir/Dialect/MemRef/Transforms/Passes.td

51

This should actually point to: https://mlir.llvm.org/docs/Dialects/Builtin/#affine-map-layout

[sotoshigoto]

Update doc based on the review comments

[sotoshigoto]

Upload patch to fix a ci error

[sotoshigoto]

@bondhugula Ping

[sotoshigoto]

Could someone review this patch document and provide feedback?

mlir/docs/Passes.md

 ## Bufferization Passes
 
 [include "BufferizationPasses.md"]
 
 ## Conversion Passes
 
 [include "ConversionPasses.md"]
 
-## `async` Dialect Passes
+## 'async' Dialect Passes
 
 [include "AsyncPasses.md"]
 
-## `affine` Dialect Passes
+## 'affine' Dialect Passes
 
 [include "AffinePasses.md"]
 
-## `arith` Dialect Passes
+## 'arith' Dialect Passes
 
 [include "ArithPasses.md"]
 
-## `func` Dialect Passes
+## 'func' Dialect Passes
 
 [include "FuncPasses.md"]
 
-## `gpu` Dialect Passes
+## 'gpu' Dialect Passes
 
 [include "GPUPasses.md"]
 
-## `linalg` Dialect Passes
+## 'linalg' Dialect Passes
 
 [include "LinalgPasses.md"]
 
-## `llvm` Dialect Passes
+## 'llvm' Dialect Passes
 
 [include "LLVMPasses.md"]
 
-## `memref` Dialect Passes
+## 'memref' Dialect Passes
 
 [include "MemRefPasses.md"]
 
-## `quant` Dialect Passes
+## 'quant' Dialect Passes
 
 [include "QuantPasses.md"]
 
 ## Reducer Passes
 
 [include "ReducerPasses.md"]
 
-## `scf` Dialect Passes
+## 'scf' Dialect Passes
 
 [include "SCFPasses.md"]
 
-## `shape` Dialect Passes
+## 'shape' Dialect Passes
 
 [include "ShapePasses.md"]
 
-## `sparse_tensor` Dialect Passes
+## 'sparse_tensor' Dialect Passes
 
 [include "SparseTensorPasses.md"]
 
-## `spv` Dialect Passes
+## 'spv' Dialect Passes
 
 [include "SPIRVPasses.md"]
 
-## `tensor` Dialect Passes
+## 'tensor' Dialect Passes
 
 [include "TensorPasses.md"]
 
-## `transform` Dialect Passes
+## 'transform' Dialect Passes
 
 [include "TransformPasses.md"]
 
-## `vector` Dialect Passes
+## 'vector' Dialect Passes
 
 [include "VectorPasses.md"]
 
+## 'nvgpu' Dialect Passes
+
+[include "NVGPUPasses.md"]
+
 ## TOSA Dialect Passes
 
 [include "TosaPasses.md"]

mlir/include/mlir/Conversion/Passes.td

 }
 
 //===----------------------------------------------------------------------===//
 // MemRefToLLVM
 //===----------------------------------------------------------------------===//
 
 def FinalizeMemRefToLLVMConversionPass :
     Pass<"finalize-memref-to-llvm", "ModuleOp"> {
-  let summary = "Finalize the conversion of the operations from the MemRef "
-                "dialect to the LLVM dialect."
-                "This conversion will not convert some complex MemRef "
-                "operations. Make sure to run `expand-strided-metadata` "
-                "beforehand for these.";
+  let summary = "Convert MemRef dialect to LLVM dialect";
+  let description = [{
+    Finalize the conversion of the operations from the MemRef 
+    dialect to the LLVM dialect.
+    This conversion will not convert some complex MemRef 
+    operations. Make sure to run `expand-strided-metadata` 
+    beforehand for these.
+  }];
   let dependentDialects = ["LLVM::LLVMDialect"];
   let options = [
     Option<"useAlignedAlloc", "use-aligned-alloc", "bool", /*default=*/"false",
            "Use aligned_alloc in place of malloc for heap allocations">,
     Option<"indexBitwidth", "index-bitwidth", "unsigned",
            /*default=kDeriveIndexBitwidthFromDataLayout*/"0",
            "Bitwidth of the index type, 0 to use size of machine word">,
     Option<"useGenericFunctions", "use-generic-functions",

mlir/include/mlir/Dialect/MemRef/Transforms/Passes.td

def MemRefEmulateWideInt : Pass<"memref-emulate-wide-int"> {
   ];
   let dependentDialects = ["vector::VectorDialect"];
 }
 
 def NormalizeMemRefs : Pass<"normalize-memrefs", "ModuleOp"> {
   let summary = "Normalize memrefs";
    let description = [{
     This pass transforms memref types with a non-trivial
-    [layout map](https://mlir.llvm.org/docs/LangRef/#layout-map) into
-    memref types with an identity layout map, e.g. (i, j) -> (i, j). This
+    [layout map](https://mlir.llvm.org/docs/Rationale/Rationale/#data-layout-of-non-primitive-types)
+    into memref types with an identity layout map, e.g. (i, j) -> (i, j). This
     pass is inter-procedural, in the sense that it can modify function
     interfaces and call sites that pass memref types. In order to modify
     memref types while preserving the original behavior, users of those
     memref types are also modified to incorporate the resulting layout map.
-    For instance, an [AffineLoadOp]
-    (https://mlir.llvm.org/docs/Dialects/Affine/#affineload-affineloadop)
+    For instance, an [AffineLoadOp](https://mlir.llvm.org/docs/Dialects/Affine/#affineload-mliraffineloadop)
     will be updated to compose the layout map with with the affine expression
-    contained in the op. Operations marked with the [MemRefsNormalizable]
-    (https://mlir.llvm.org/docs/Traits/#memrefsnormalizable) trait are
-    expected to be normalizable. Supported operations include affine
+    contained in the op. Operations marked with the
+    [MemRefsNormalizable](https://mlir.llvm.org/docs/Traits/#memrefsnormalizable)
+    trait are expected to be normalizable. Supported operations include affine
     operations, memref.alloc, memref.dealloc, and func.return.
 
     Given an appropriate layout map specified in the code, this transformation
     can express tiled or linearized access to multi-dimensional data
     structures, but will not modify memref types without an explicit layout
     map.
 
     Currently this pass is limited to only modify

mlir/include/mlir/Transforms/Passes.td

let description = [{
     // old:
     ... loc("original_source.cpp":1:1)
 
     // new:
     ... loc("snapshot_source.mlir":10:10)
     ```
 
     * If set, the new location is fused with the original location in the form
-    of a [`Name Location`](Diagnostics.md#name-location) with the specified tag.
+    of a [`Name Location`](Dialects/Builtin.md/#nameloc) with the specified tag.
 
     Example:
 
     ```mlir
     // old:
     ... loc("original_source.cpp":1:1)
 
     // new:
def SCCP : Pass<"sccp"> {
   }];
   let constructor = "mlir::createSCCPPass()";
 }
 
 def StripDebugInfo : Pass<"strip-debuginfo"> {
   let summary = "Strip debug info from all operations";
   let description = [{
     This pass strips the IR of any location information, by replacing all
-    operation locations with [`unknown`](Diagnostics.md#unknown-location).
+    operation locations with [`unknown`](Dialects/Builtin.md/#unknownloc).
   }];
   let constructor = "mlir::createStripDebugInfoPass()";
 }
 
 def SymbolDCE : Pass<"symbol-dce"> {
   let summary = "Eliminate dead symbols";
   let description = [{
     This pass deletes all symbols that are found to be unreachable. This is done
     by computing the set of operations that are known to be live, propagating
     that liveness to other symbols, and then deleting all symbols that are not
     within this live set. Live symbols are those that have a
-    [visibility](SymbolsAndSymbolTables.md#symbol-visibility) that extends
+    [visibility](SymbolsAndSymbolTables.md/#symbol-visibility) that extends
     beyond the IR, e.g. `public`, or those that are referenced by live symbols
     or other non-Symbol operations.
 
     For example, consider the following input:
 
     ```mlir
     func.func private @dead_private_function()
     func.func private @live_private_function()