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 | b6d1f39cd0ed77997007db2053a5b5e277c67fc9 (patch) | |
| tree | e640338c04a7c65a96934da1c79f34ea4b0ee051 /docs | |
| parent | 25f34a30d66e33381a023d97d72ce44ded2c7f72 (diff) | |
| download | llvm-b6d1f39cd0ed77997007db2053a5b5e277c67fc9.tar.gz llvm-b6d1f39cd0ed77997007db2053a5b5e277c67fc9.tar.bz2 llvm-b6d1f39cd0ed77997007db2053a5b5e277c67fc9.tar.xz | |
Fix documentation for these functions; they do not only modify users within the
block specified by the InstList. Patch by Stefanus Du Toit.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@56200 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ProgrammersManual.html | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index fad5edf180..ba8a38be9a 100644 --- a/docs/ProgrammersManual.html +++ b/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> |