[Mlir-commits] [mlir] fix: typos in documentation (PR #120179)
Timothy Hoffman
llvmlistbot at llvm.org
Mon Dec 16 20:20:04 PST 2024
https://github.com/tim-hoffman updated https://github.com/llvm/llvm-project/pull/120179
>From 411d7c1f900745570e7af691d016db920393094a Mon Sep 17 00:00:00 2001
From: Tim Hoffman <timothy.hoffman at veridise.com>
Date: Mon, 16 Dec 2024 22:11:59 -0600
Subject: [PATCH 1/2] fix: typos in documentation
---
mlir/docs/PatternRewriter.md | 2 +-
mlir/docs/SymbolsAndSymbolTables.md | 6 +++---
mlir/include/mlir/IR/DialectImplementation.h | 2 +-
mlir/include/mlir/IR/OpBase.td | 2 +-
mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h | 2 +-
5 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/mlir/docs/PatternRewriter.md b/mlir/docs/PatternRewriter.md
index 2f1483db8190a7..da392b82893323 100644
--- a/mlir/docs/PatternRewriter.md
+++ b/mlir/docs/PatternRewriter.md
@@ -464,7 +464,7 @@ Passes that utilize rewrite patterns should aim to provide a common set of
options and toggles to simplify the debugging experience when switching between
different passes/projects/etc. To aid in this endeavor, MLIR provides a common
set of utilities that can be easily included when defining a custom pass. These
-are defined in `mlir/RewritePassUtil.td`; an example usage is shown below:
+are defined in `mlir/Rewrite/PassUtil.td`; an example usage is shown below:
```tablegen
def MyRewritePass : Pass<"..."> {
diff --git a/mlir/docs/SymbolsAndSymbolTables.md b/mlir/docs/SymbolsAndSymbolTables.md
index 9078aef898d8b0..aa7b1a71547bf3 100644
--- a/mlir/docs/SymbolsAndSymbolTables.md
+++ b/mlir/docs/SymbolsAndSymbolTables.md
@@ -21,14 +21,14 @@ into the system.
The `Symbol` infrastructure essentially provides a non-SSA mechanism in which to
refer to an operation symbolically with a name. This allows for referring to
operations defined above regions that were defined as `IsolatedFromAbove` in a
-safe way. It also allows for symbolically referencing operations define below
+safe way. It also allows for symbolically referencing operations defined below
other regions as well.
## Symbol
A `Symbol` is a named operation that resides immediately within a region that
defines a [`SymbolTable`](#symbol-table). The name of a symbol *must* be unique
-within the parent `SymbolTable`. This name is semantically similarly to an SSA
+within the parent `SymbolTable`. This name is semantically similar to an SSA
result value, and may be referred to by other operations to provide a symbolic
link, or use, to the symbol. An example of a `Symbol` operation is
[`func.func`](Dialects/Builtin.md/#func-mlirfuncop). `func.func` defines a
@@ -125,7 +125,7 @@ Using an attribute, as opposed to an SSA value, has several benefits:
- If we were to use SSA values, we would need to create some mechanism in
which to opt-out of certain properties of it such as dominance.
- Attributes allow for referencing the operations irregardless of the
+ Attributes allow for referencing the operations regardless of the
order in which they were defined.
- Attributes simplify referencing operations within nested symbol tables,
which are traditionally not visible outside of the parent region.
diff --git a/mlir/include/mlir/IR/DialectImplementation.h b/mlir/include/mlir/IR/DialectImplementation.h
index 303564bf66470d..f45b88dc6decad 100644
--- a/mlir/include/mlir/IR/DialectImplementation.h
+++ b/mlir/include/mlir/IR/DialectImplementation.h
@@ -89,7 +89,7 @@ struct FieldParser<
}
};
-/// Parse an attribute.
+/// Parse a type.
template <typename TypeT>
struct FieldParser<
TypeT, std::enable_if_t<std::is_base_of<Type, TypeT>::value, TypeT>> {
diff --git a/mlir/include/mlir/IR/OpBase.td b/mlir/include/mlir/IR/OpBase.td
index 5c82c041c62eeb..51b60972203e7f 100644
--- a/mlir/include/mlir/IR/OpBase.td
+++ b/mlir/include/mlir/IR/OpBase.td
@@ -401,7 +401,7 @@ class Op<Dialect dialect, string mnemonic, list<Trait> props = []> {
// an additional `LogicalResult verify()` declaration will be generated on the
// operation class. The operation should implement this method and verify the
// additional necessary invariants. This verifier shouldn't access any nested
- // operations because those operations may ill-formed. Use the
+ // operations because those operations may be ill-formed. Use the
// `hasRegionVerifier` below instead.
bit hasVerifier = 0;
diff --git a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
index 160585e7da5486..09bd86b9581df9 100644
--- a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
+++ b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
@@ -325,7 +325,7 @@ LogicalResult MlirOptMain(int argc, char **argv, llvm::StringRef toolName,
DialectRegistry ®istry);
/// Implementation for tools like `mlir-opt`.
-/// This function can be used with registrationAndParseCLIOptions so that
+/// This function can be used with registerAndParseCLIOptions so that
/// CLI options can be accessed before running MlirOptMain.
/// - inputFilename is the name of the input mlir file.
/// - outputFilename is the name of the output file.
>From f43369a13896562546b9a59c6e8045be0178acce Mon Sep 17 00:00:00 2001
From: Tim Hoffman <timothy.hoffman at veridise.com>
Date: Mon, 16 Dec 2024 22:19:53 -0600
Subject: [PATCH 2/2] fix: documentation for custom parsing
Documentation for `custom<X>` in `assemblyFormat` used the wrong return type. See `parsePrettyLLVMType()` in LLVMTypes.h, `parseSingleBlockRegion()` in IRDL.cpp, `parseDynamicIndexList()` in ViewLikeInterface.cpp, etc.
---
mlir/docs/DefiningDialects/AttributesAndTypes.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/mlir/docs/DefiningDialects/AttributesAndTypes.md b/mlir/docs/DefiningDialects/AttributesAndTypes.md
index 1430edd2ffb025..44be4c8ed3dccd 100644
--- a/mlir/docs/DefiningDialects/AttributesAndTypes.md
+++ b/mlir/docs/DefiningDialects/AttributesAndTypes.md
@@ -890,7 +890,7 @@ The `custom` directive `custom<Foo>($foo)` will in the parser and printer
respectively generate calls to:
```c++
-LogicalResult parseFoo(AsmParser &parser, int &foo);
+ParseResult parseFoo(AsmParser &parser, int &foo);
void printFoo(AsmPrinter &printer, int foo);
```
@@ -907,7 +907,7 @@ let assemblyFormat = "custom<Fizz>($foobar)";
It will generate calls expecting the following signature for `parseFizz`:
```c++
-LogicalResult parseFizz(AsmParser &parser, FailureOr<NotDefaultConstructible> &foobar);
+ParseResult parseFizz(AsmParser &parser, FailureOr<NotDefaultConstructible> &foobar);
```
A previously bound variable can be passed as a parameter to a `custom` directive
@@ -916,7 +916,7 @@ the first directive. The second directive references it and expects the
following printer and parser signatures:
```c++
-LogicalResult parseBar(AsmParser &parser, int &bar, int foo);
+ParseResult parseBar(AsmParser &parser, int &bar, int foo);
void printBar(AsmPrinter &printer, int bar, int foo);
```
@@ -925,7 +925,7 @@ is that the parameter for the parser must use the storage type of the parameter.
For example, `StringRefParameter` expects the parser and printer signatures as:
```c++
-LogicalResult parseStringParam(AsmParser &parser, std::string &value);
+ParseResult parseStringParam(AsmParser &parser, std::string &value);
void printStringParam(AsmPrinter &printer, StringRef value);
```
More information about the Mlir-commits
mailing list