[PATCH] D77956: [MLIR][NFC] add doc cross links from/to std.alloca

Uday Bondhugula via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Sat Apr 11 14:56:15 PDT 2020


bondhugula created this revision.
Herald added subscribers: llvm-commits, frgossen, grosul1, Joonsoo, liufengdb, lucyrfox, mgester, arpith-jacob, nicolasvasilache, antiagainst, shauheen, burmako, jpienaar, rriddle, mehdi_amini.
Herald added a project: LLVM.

Add doc cross links between std.alloca and AutomaticAllocationScope.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D77956

Files:
  mlir/docs/Traits.md
  mlir/include/mlir/Dialect/StandardOps/IR/Ops.td


Index: mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
===================================================================
--- mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
+++ mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
@@ -327,7 +327,8 @@
   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
+    surrounding operation with an
+    [`AutomaticAllocationScope`](../Traits.md#automaticallocationscope) trait. The amount of
     memory allocated is specified by its memref and additional operands. For
     example:
 
Index: mlir/docs/Traits.md
===================================================================
--- mlir/docs/Traits.md
+++ mlir/docs/Traits.md
@@ -142,8 +142,9 @@
 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
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D77956.256802.patch
Type: text/x-patch
Size: 1512 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200411/effb7aee/attachment.bin>


More information about the llvm-commits mailing list