[Mlir-commits] [mlir] 75ea9e4 - [MLIR][NFC] add doc cross links from/to std.alloca
Uday Bondhugula
llvmlistbot at llvm.org
Sat Apr 11 15:03:50 PDT 2020
Author: Uday Bondhugula
Date: 2020-04-12T03:33:19+05:30
New Revision: 75ea9e4e40ca34f06ce423508a1f47fa0bb6df9e
URL: https://github.com/llvm/llvm-project/commit/75ea9e4e40ca34f06ce423508a1f47fa0bb6df9e
DIFF: https://github.com/llvm/llvm-project/commit/75ea9e4e40ca34f06ce423508a1f47fa0bb6df9e.diff
LOG: [MLIR][NFC] add doc cross links from/to std.alloca
Add doc cross links between std.alloca and AutomaticAllocationScope.
Subscribers: mehdi_amini, rriddle, jpienaar, burmako, shauheen, antiagainst, nicolasvasilache, arpith-jacob, mgester, lucyrfox, liufengdb, Joonsoo, grosul1, frgossen, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D77956
Added:
Modified:
mlir/docs/Traits.md
mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
Removed:
################################################################################
diff --git a/mlir/docs/Traits.md b/mlir/docs/Traits.md
index 346b57642c10..72f7d8a2b8f3 100644
--- a/mlir/docs/Traits.md
+++ b/mlir/docs/Traits.md
@@ -142,8 +142,9 @@ section goes as follows:
This trait is carried by region holding operations that define a new scope for
automatic allocation. Such allocations are automatically freed when control is
transferred back from the regions of such operations. As an example, allocations
-performed by std.alloca are automatically freed when control leaves the region
-of its closest surrounding op that has the trait AutomaticAllocationScope.
+performed by [`std.alloca`](Dialects/Standard.md#stdalloca-allocaop) are
+automatically freed when control leaves the region of its closest surrounding op
+that has the trait AutomaticAllocationScope.
### Broadcastable
diff --git a/mlir/include/mlir/Dialect/StandardOps/IR/Ops.td b/mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
index 55478a4ae9c2..4693ca478246 100644
--- a/mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
+++ b/mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
@@ -327,9 +327,10 @@ def AllocaOp : AllocLikeOp<"alloca"> {
let description = [{
The `alloca` operation allocates memory on the stack, to be automatically
released when control transfers back from the region of its closest
- surrounding operation with a AutomaticAllocationScope trait. The amount of
- memory allocated is specified by its memref and additional operands. For
- example:
+ surrounding operation with an
+ [`AutomaticAllocationScope`](../Traits.md#automaticallocationscope) trait.
+ The amount of memory allocated is specified by its memref and additional
+ operands. For example:
```mlir
%0 = alloca() : memref<8x64xf32>
More information about the Mlir-commits
mailing list