-
Notifications
You must be signed in to change notification settings - Fork 14.3k
Documentation updates and typo fixes #125273
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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The type mentioned caused compiler errors. For existing code that uses the proper type see `mlir/Dialect/LLVMIR/LLVMOps.td` and `mlir/Dialect/ControlFlow/IR/ControlFlowOps.td`
`prop-dict` is supported in custom directive since llvm#77061 but documentation was not added here
@llvm/pr-subscribers-mlir-core @llvm/pr-subscribers-mlir Author: Timothy Hoffman (tim-hoffman) ChangesFull diff: https://github.com/llvm/llvm-project/pull/125273.diff 3 Files Affected:
diff --git a/mlir/docs/DefiningDialects/Operations.md b/mlir/docs/DefiningDialects/Operations.md
index 8ff60ac21424c4..2adaf181de28a1 100644
--- a/mlir/docs/DefiningDialects/Operations.md
+++ b/mlir/docs/DefiningDialects/Operations.md
@@ -248,7 +248,7 @@ To declare a variadic operand that has a variadic number of sub-ranges, wrap the
`TypeConstraint` for the operand with `VariadicOfVariadic<...,
"<segment-attribute-name>">`.
-The second field of the `VariadicOfVariadic` is the name of an `I32ElementsAttr`
+The second field of the `VariadicOfVariadic` is the name of a `DenseI32ArrayAttr`
argument that contains the sizes of the variadic sub-ranges. This attribute will
be used when determining the size of sub-ranges, or when updating the size of
sub-ranges.
@@ -887,11 +887,12 @@ declarative parameter to `parse` method argument is detailed below:
- Variadic: `SmallVectorImpl<Type> &`
- VariadicOfVariadic: `SmallVectorImpl<SmallVector<Type>> &`
* `attr-dict` Directive: `NamedAttrList &`
+* `prop-dict` Directive: `OperationState &`
When a variable is optional, the value should only be specified if the variable
is present. Otherwise, the value should remain `None` or null.
-The arguments to the `print<UserDirective>` method is firstly a reference to the
+The arguments to the `print<UserDirective>` method are firstly a reference to the
`OpAsmPrinter`(`OpAsmPrinter &`), second the op (e.g. `FooOp op` which can be
`Operation *op` alternatively), and finally a set of output parameters
corresponding to the parameters specified in the format. The mapping of
@@ -921,6 +922,7 @@ declarative parameter to `print` method argument is detailed below:
- Variadic: `TypeRange`
- VariadicOfVariadic: `TypeRangeRange`
* `attr-dict` Directive: `DictionaryAttr`
+* `prop-dict` Directive: `FooOp::Properties`
When a variable is optional, the provided value may be null. When a variable is
referenced in a custom directive parameter using `ref`, it is passed in by
diff --git a/mlir/docs/Traits/_index.md b/mlir/docs/Traits/_index.md
index 3fa24ec77107f0..4127fe75dc6f5a 100644
--- a/mlir/docs/Traits/_index.md
+++ b/mlir/docs/Traits/_index.md
@@ -8,10 +8,9 @@ mechanism which abstracts implementation details and properties that are common
across many different attributes/operations/types/etc.. `Traits` may be used to
specify special properties and constraints of the object, including whether an
operation has side effects or that its output has the same type as the input.
-Some examples of operation traits are `Commutative`, `SingleResult`,
-`Terminator`, etc. See the more comprehensive list of
-[operation traits](#operation-traits-list) below for more examples of what is
-possible.
+Some examples of operation traits are `Commutative`, `Terminator`, etc. See the
+more comprehensive list of [operation traits](#operation-traits-list) below for
+more examples of what is possible.
## Defining a Trait
diff --git a/mlir/include/mlir/IR/BuiltinAttributeInterfaces.td b/mlir/include/mlir/IR/BuiltinAttributeInterfaces.td
index 017559cc353e6b..6220d80264bdf0 100644
--- a/mlir/include/mlir/IR/BuiltinAttributeInterfaces.td
+++ b/mlir/include/mlir/IR/BuiltinAttributeInterfaces.td
@@ -481,7 +481,7 @@ def MemRefLayoutAttrInterface : AttrInterface<"MemRefLayoutAttrInterface"> {
Note: the MemRef type's layout is assumed to represent simple strided buffer
layout. For more complicated case, like sparse storage buffers,
it is preferable to use separate type with more specic layout, rather then
- introducing extra complexity to the builin MemRef type.
+ introducing extra complexity to the builtin MemRef type.
}];
let methods = [
|
joker-eph
approved these changes
Feb 24, 2025
joker-eph
approved these changes
Apr 15, 2025
var-const
pushed a commit
to ldionne/llvm-project
that referenced
this pull request
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.