[llvm-commits] [PATCH] minor documentation fixes for programmer's manual

[Stefanus Du Toit]

The following tiny patch fixes the documentation for  
ReplaceInstWithValue in the programmer's manual, and gives more  
details on ReplaceInstWithInst.

Index: docs/ProgrammersManual.html
===================================================================
--- docs/ProgrammersManual.html (revision 56103)
+++ docs/ProgrammersManual.html (working copy)
@@ -1944,7 +1944,7 @@
  <ul>
    <li><tt>ReplaceInstWithValue</tt>

-    <p>This function replaces all uses (within a basic block) of a  
given
+    <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
@@ -1962,8 +1962,11 @@
    <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>


--
Stefanus Du Toit <stefanus.dutoit at rapidmind.com>
   RapidMind Inc.
   phone: +1 519 885 5455 x116 -- fax: +1 519 885 1463