diff options
author | Nick Lewycky <nicholas@mxc.ca> | 2008-09-15 06:31:52 +0000 |
---|---|---|
committer | Nick Lewycky <nicholas@mxc.ca> | 2008-09-15 06:31:52 +0000 |
commit | 57368a561f88263bbe2f99b597fb3d9c86ea192a (patch) | |
tree | 16498d443d7969649131c60c462b90ec609619cb /llvm/docs/ProgrammersManual.html | |
parent | 02acc35abd1679733c76792e026fa3bc55f306fd (diff) | |
download | bcm5719-llvm-57368a561f88263bbe2f99b597fb3d9c86ea192a.tar.gz bcm5719-llvm-57368a561f88263bbe2f99b597fb3d9c86ea192a.zip |
Fix documentation for these functions; they do not only modify users within the
block specified by the InstList. Patch by Stefanus Du Toit.
llvm-svn: 56200
Diffstat (limited to 'llvm/docs/ProgrammersManual.html')
-rw-r--r-- | llvm/docs/ProgrammersManual.html | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/llvm/docs/ProgrammersManual.html b/llvm/docs/ProgrammersManual.html index fad5edf1801..ba8a38be9a9 100644 --- a/llvm/docs/ProgrammersManual.html +++ b/llvm/docs/ProgrammersManual.html @@ -1944,9 +1944,9 @@ and <tt>ReplaceInstWithInst</tt>.</p> <ul> <li><tt>ReplaceInstWithValue</tt> - <p>This function replaces all uses (within a basic block) of a given - instruction with a value, and then removes the original instruction. The - following example illustrates the replacement of the result of a particular + <p>This function replaces all uses of a given instruction with a value, + and then removes the original instruction. The following example + illustrates the replacement of the result of a particular <tt>AllocaInst</tt> that allocates memory for a single integer with a null pointer to an integer.</p> @@ -1962,8 +1962,10 @@ ReplaceInstWithValue(instToReplace->getParent()->getInstList(), ii, <li><tt>ReplaceInstWithInst</tt> <p>This function replaces a particular instruction with another - instruction. The following example illustrates the replacement of one - <tt>AllocaInst</tt> with another.</p> + instruction, inserting the new instruction into the basic block at the + location where the old instruction was, and replacing any uses of the old + instruction with the new instruction. The following example illustrates + the replacement of one <tt>AllocaInst</tt> with another.</p> <div class="doc_code"> <pre> |