From 3266f9c3d6ae07289d0253d1efeb3d951830105c Mon Sep 17 00:00:00 2001 From: Timothy Hoffman <4001421+tim-hoffman@users.noreply.github.com> Date: Tue, 15 Apr 2025 03:27:58 -0500 Subject: [PATCH] [MLIR] Documentation updates and typo fixes (#125273) --- mlir/docs/DefiningDialects/Operations.md | 6 ++++-- mlir/docs/Traits/_index.md | 7 +++---- mlir/include/mlir/IR/BuiltinAttributeInterfaces.td | 2 +- mlir/lib/IR/SymbolTable.cpp | 6 +++--- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/mlir/docs/DefiningDialects/Operations.md b/mlir/docs/DefiningDialects/Operations.md index 21ba31d60906..986ae292d64c 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<..., "">`. -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. @@ -906,11 +906,12 @@ declarative parameter to `parse` method argument is detailed below: - Variadic: `SmallVectorImpl &` - VariadicOfVariadic: `SmallVectorImpl> &` * `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` method is firstly a reference to the +The arguments to the `print` 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 @@ -940,6 +941,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 3fa24ec77107..4127fe75dc6f 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 017559cc353e..6220d80264bd 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 = [ diff --git a/mlir/lib/IR/SymbolTable.cpp b/mlir/lib/IR/SymbolTable.cpp index 71422191c145..76c9b7b1e8af 100644 --- a/mlir/lib/IR/SymbolTable.cpp +++ b/mlir/lib/IR/SymbolTable.cpp @@ -808,9 +808,9 @@ static std::optional getSymbolUsesImpl(SymbolT symbol, } /// Get all of the uses of the given symbol that are nested within the given -/// operation 'from', invoking the provided callback for each. This does not -/// traverse into any nested symbol tables. This function returns std::nullopt -/// if there are any unknown operations that may potentially be symbol tables. +/// operation 'from'. This does not traverse into any nested symbol tables. +/// This function returns std::nullopt if there are any unknown operations that +/// may potentially be symbol tables. auto SymbolTable::getSymbolUses(StringAttr symbol, Operation *from) -> std::optional { return getSymbolUsesImpl(symbol, from);