Update annotation intrinsic with more details.
authorTanya Lattner <tonic@nondot.org>
Fri, 21 Sep 2007 23:56:27 +0000 (23:56 +0000)
committerTanya Lattner <tonic@nondot.org>
Fri, 21 Sep 2007 23:56:27 +0000 (23:56 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@42214 91177308-0d34-0410-b5e6-96231b3b80d8

docs/LangRef.html

index 05f4e66f882ade69612267266398f4eab787bab9..66c5f13de0caaa2b4af56ef1b962df37a2c0eba2 100644 (file)
       <li><a href="#int_general">General intrinsics</a>
         <ol>
           <li><a href="#int_var_annotation">
-            <tt>llvm.var.annotation</tt>' Intrinsic</a></li>
+            <tt>llvm.var.annotation.*</tt>' Intrinsic</a></li>
         </ol>
         <ol>
           <li><a href="#int_annotation">
@@ -5275,13 +5275,22 @@ This can be useful for special purpose optimizations that want to look for these
 <div class="doc_text">
 
 <h5>Syntax:</h5>
+<p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on 
+any integer bit width. 
+</p>
 <pre>
   declare i32 @llvm.annotation(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
+  declare i8 llvm.annotation(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
+  declare i16 llvm.annotation(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
+  declare i32 @llvm.annotation(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
+  declare i64 @llvm.annotation(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
+  declare i256 @llvm.annotation(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
 </pre>
 
 <h5>Overview:</h5>
-<p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on 
-any integer bit width. Not all targets support all bit widths however.
+
+<p>
+The '<tt>llvm.annotation</tt>' intrinsic.
 </p>
 
 <h5>Arguments:</h5>
@@ -5290,6 +5299,7 @@ any integer bit width. Not all targets support all bit widths however.
 The first argument is an integer value (result of some expression), 
 the second is a pointer to a global string, the third is a pointer to a global 
 string which is the source file name, and the last argument is the line number.
+It returns the value of the first argument.
 </p>
 
 <h5>Semantics:</h5>