Skip to content

Commit a90a09f

Browse files
author
mlevesquedion
authored
[mlir][docs] Fix broken links to traits documentation (#82131)
It seems the `Traits.md` file was turned into `Traits/_index.md` in https://reviews.llvm.org/D153291, causing links to `Traits.md` to no longer work (instead, `Traits` needs to be used).
1 parent 3bef17e commit a90a09f

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

mlir/docs/DefiningDialects/AttributesAndTypes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ MLIR includes several specialized classes for common situations:
305305
Similarly to operations, Attribute and Type classes may attach `Traits` that
306306
provide additional mixin methods and other data. `Trait`s may be attached via
307307
the trailing template argument, i.e. the `traits` list parameter in the example
308-
above. See the main [`Trait`](../Traits.md) documentation for more information
308+
above. See the main [`Trait`](../Traits) documentation for more information
309309
on defining and using traits.
310310

311311
### Interfaces

mlir/docs/Interfaces.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ methods that are overridden by the `Model` that is templated on the concrete
132132
entity type. It is important to note that these classes should be pure, and
133133
should not contain non-static data members or other mutable data. To attach an
134134
interface to an object, the base interface classes provide a
135-
[`Trait`](Traits.md) class that can be appended to the trait list of that
135+
[`Trait`](Traits) class that can be appended to the trait list of that
136136
object.
137137
138138
```c++
@@ -420,7 +420,7 @@ comprised of the following components:
420420
- A C++ code block containing additional verification applied to the
421421
operation that the interface is attached to.
422422
- The structure of this code block corresponds 1-1 with the structure of a
423-
[`Trait::verifyTrait`](Traits.md) method.
423+
[`Trait::verifyTrait`](Traits) method.
424424

425425
##### Interface Methods
426426

@@ -457,7 +457,7 @@ Interface methods are comprised of the following components:
457457
- This implementation is placed within the `Trait` class that is attached
458458
to the IR entity, and does not directly affect any of the interface
459459
classes. As such, this method has the same characteristics as any other
460-
[`Trait`](Traits.md) method.
460+
[`Trait`](Traits) method.
461461
- `ConcreteAttr`/`ConcreteOp`/`ConcreteType` is an implicitly defined
462462
`typename` that can be used to refer to the type of the derived IR
463463
entity currently being operated on.
@@ -601,7 +601,7 @@ def MyInterface : OpInterface<"MyInterface"> {
601601
};
602602
```
603603
604-
As detailed in [Traits](Traits.md), given that each operation implementing
604+
As detailed in [Traits](Traits), given that each operation implementing
605605
this interface will also add the interface trait, the methods on this
606606
interface are inherited by the derived operation. This allows for
607607
injecting a default implementation of this method into each operation that

mlir/docs/LangRef.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ using familiar concepts of compiler [Passes](Passes.md). Enabling an arbitrary
4949
set of passes on an arbitrary set of operations results in a significant scaling
5050
challenge, since each transformation must potentially take into account the
5151
semantics of any operation. MLIR addresses this complexity by allowing operation
52-
semantics to be described abstractly using [Traits](Traits.md) and
52+
semantics to be described abstractly using [Traits](Traits) and
5353
[Interfaces](Interfaces.md), enabling transformations to operate on operations
5454
more generically. Traits often describe verification constraints on valid IR,
5555
enabling complex invariants to be captured and checked. (see
@@ -234,7 +234,7 @@ their regions. For instance, the scope of values in a region with
234234
[SSA control flow semantics](#control-flow-and-ssacfg-regions) is constrained
235235
according to the standard definition of
236236
[SSA dominance](https://en.wikipedia.org/wiki/Dominator_\(graph_theory\)).
237-
Another example is the [IsolatedFromAbove trait](Traits.md/#isolatedfromabove),
237+
Another example is the [IsolatedFromAbove trait](Traits/#isolatedfromabove),
238238
which restricts directly accessing values defined in containing regions.
239239

240240
Function identifiers and mapping identifiers are associated with
@@ -478,7 +478,7 @@ the enclosing region, if any. By default, operations inside a region can
478478
reference values defined outside of the region whenever it would have been legal
479479
for operands of the enclosing operation to reference those values, but this can
480480
be restricted using traits, such as
481-
[OpTrait::IsolatedFromAbove](Traits.md/#isolatedfromabove), or a custom
481+
[OpTrait::IsolatedFromAbove](Traits/#isolatedfromabove), or a custom
482482
verifier.
483483

484484
Example:

mlir/docs/PassManagement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ specific operation, and executed on any viable operation type). Operation types
362362
anchor pass managers must adhere to the following requirement:
363363

364364
* Must be registered and marked
365-
[`IsolatedFromAbove`](Traits.md/#isolatedfromabove).
365+
[`IsolatedFromAbove`](Traits/#isolatedfromabove).
366366

367367
* Passes are expected not to modify operations at or above the current
368368
operation being processed. If the operation is not isolated, it may

mlir/docs/SymbolsAndSymbolTables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ around this nesting structure; including the processing of operations within the
88
[pass manager](PassManagement.md/#pass-manager). One advantage of the MLIR
99
design is that it is able to process operations in parallel, utilizing multiple
1010
threads. This is possible due to a property of the IR known as
11-
[`IsolatedFromAbove`](Traits.md/#isolatedfromabove).
11+
[`IsolatedFromAbove`](Traits/#isolatedfromabove).
1212

1313
Without this property, any operation could affect or mutate the use-list of
1414
operations defined above. Making this thread-safe requires expensive locking in

mlir/docs/Tutorials/Toy/Ch-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ This operation takes zero operands, a
245245
`value` to represent the constant value, and returns a single result of
246246
[RankedTensorType](../../Dialects/Builtin.md/#rankedtensortype). An operation class
247247
inherits from the [CRTP](https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern)
248-
`mlir::Op` class which also takes some optional [*traits*](../../Traits.md) to
248+
`mlir::Op` class which also takes some optional [*traits*](../../Traits) to
249249
customize its behavior. `Traits` are a mechanism with which we can inject
250250
additional behavior into an Operation, such as additional accessors,
251251
verification, and more. Let's look below at a possible definition for the

0 commit comments

Comments
 (0)