diff options
| author | Philip Reames <listmail@philipreames.com> | 2015-02-25 23:07:34 +0000 |
|---|---|---|
| committer | Philip Reames <listmail@philipreames.com> | 2015-02-25 23:07:34 +0000 |
| commit | 09b52fd1ae7c8880be8c19429df7b2ebe2cafc44 (patch) | |
| tree | d2acbb39d56ac961c3a38a188acb3438997468e9 /llvm/docs | |
| parent | 819045cdd6b4c3ea3522e5db2e4c69a8744f2ae6 (diff) | |
| download | bcm5719-llvm-09b52fd1ae7c8880be8c19429df7b2ebe2cafc44.tar.gz bcm5719-llvm-09b52fd1ae7c8880be8c19429df7b2ebe2cafc44.zip | |
[GC Docs] Minor wording clarification
llvm-svn: 230570
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/GarbageCollection.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/llvm/docs/GarbageCollection.rst b/llvm/docs/GarbageCollection.rst index b5a3b1f527b..d9ae6c1b505 100644 --- a/llvm/docs/GarbageCollection.rst +++ b/llvm/docs/GarbageCollection.rst @@ -247,9 +247,9 @@ Using ``llvm.gcwrite`` The ``llvm.gcroot`` intrinsic is used to inform LLVM that a stack variable references an object on the heap and is to be tracked for garbage collection. -The exact impact on generated code is specified by a :ref:`compiler plugin -<plugin>`. All calls to ``llvm.gcroot`` **must** reside inside the first basic -block. +The exact impact on generated code is specified by the Function's selected +:ref:`GC strategy <plugin>`. All calls to ``llvm.gcroot`` **must** reside +inside the first basic block. The first argument **must** be a value referring to an alloca instruction or a bitcast of an alloca. The second contains a pointer to metadata that should be |

