[llvm-commits] CVS: llvm/docs/CommandGuide/llvm-prof.html index.html

Sat Nov 1 20:12:00 PST 2003

Changes in directory llvm/docs/CommandGuide:

llvm-prof.html added (r1.1)
index.html updated: 1.10 -> 1.11

---
Log message:

Checkin an initial version of the llvm-prof documentation


---
Diffs of the changes:  (+58 -11)

Index: llvm/docs/CommandGuide/llvm-prof.html
diff -c /dev/null llvm/docs/CommandGuide/llvm-prof.html:1.1
*** /dev/null	Sat Nov  1 20:11:05 2003

--- llvm/docs/CommandGuide/llvm-prof.html	Sat Nov  1 20:10:54 2003
***************
*** 0 ****
--- 1,42 ----
+ <html>
+ <title>LLVM: llvm-prof tool</title>
+ 
+ <body bgcolor=white>
+ 
+ <center><h1>LLVM: <tt>llvm-prof</tt> tool</h1></center>
+ <HR>
+ 
+ <h3>NAME</h3>
+ <tt>llvm-prof</tt>
+ 
+ <h3>SYNOPSIS</h3>
+ <tt>llvm-prof [options] [bytecode file] [LLVM passes]</tt>
+ 
+ <h3>DESCRIPTION</h3>
+ 
+ The <tt>llvm-prof</tt> tool reads in an '<tt>llvmprof.out</tt>' file, a bytecode
+ file for the program, and produces a human readable report, suitable for
+ determining where the program hotspots are.<p>
+ 
+ 
+ <h3>OPTIONS</h3>
+ 
+ <ul>
+ 	<li><tt>-annotated-llvm</tt> or <tt>-A</tt><br>
+ 
+         In addition to the normal report printed, print out the code for the
+         program, annotated we execution frequency information. This can be
+         particularly useful when trying to visualize how frequently basic blocks
+         are executed.  This is most useful with basic block profiling
+         information or better.<p>
+ </ul>
+ 
+ <h3>EXIT STATUS</h3>
+ 
+ <tt>llvm-prof</tt> returns 1 if it cannot load the bytecode file or the profile
+ information, otherwise it exits with zero.
+ 
+ <HR>
+ Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
+ </body>
+ </html>


Index: llvm/docs/CommandGuide/index.html
diff -u llvm/docs/CommandGuide/index.html:1.10 llvm/docs/CommandGuide/index.html:1.11
--- llvm/docs/CommandGuide/index.html:1.10	Thu Oct 30 18:39:28 2003
+++ llvm/docs/CommandGuide/index.html	Sat Nov  1 20:10:54 2003
@@ -30,11 +30,6 @@
 	Disassemble an LLVM bytecode file into human-readable form.
 	<p>
 
-	<dt><A href="llvm-nm.html"><b>llvm-nm</b></A>
-	<dd>
-	Print out the names and types of symbols in an LLVM bytecode file.
-	<p>
-
 	<dt><A href="analyze.html"><b>analyze</b></A>
 	<dd>
 	Analyze an LLVM bytecode file.
@@ -45,20 +40,30 @@
 	Optimize an LLVM bytecode file.
 	<p>
 
+	<dt><A href="llc.html"><b>llc</b></A>
+	<dd>
+	Compile an LLVM bytecode program into native machine code.
+
+	<dt><A href="lli.html"><b>lli</b></A>
+	<dd>
+	Run an LLVM bytecode program using either an interpreter or a
+	JIT compiler.
+	<p>
+
 	<dt><A href="llvm-link.html"><b>llvm-link</b></A>
 	<dd>
 	Link several LLVM bytecode files together into one LLVM
 	bytecode file.
 	<p>
 
-	<dt><A href="llc.html"><b>llc</b></A>
+	<dt><A href="llvm-nm.html"><b>llvm-nm</b></A>
 	<dd>
-	Compile an LLVM bytecode program into native machine code.
+	Print out the names and types of symbols in an LLVM bytecode file.
+	<p>
 
-	<dt><A href="lli.html"><b>lli</b></A>
+	<dt><A href="llvm-prof.html"><b>llvm-prof</b></A>
 	<dd>
-	Run an LLVM bytecode program using either an interpreter or a
-	JIT compiler.
+        Transform raw '<tt>llvmprof.out</tt>' data into a human readable report.
 	<p>
 </dl>
 
@@ -110,7 +115,7 @@
 <hr><font size=-1>
 Maintained by the 
 <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.<br>
-Last modified: $Date: 2003/10/31 00:39:28 $
+Last modified: $Date: 2003/11/02 02:10:54 $
 </font>
 
 </body>



