Checkin an initial version of the llvm-prof documentation

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9649 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner 2003-11-02 02:10:54 +00:00
parent d6d0d8c18d
commit e66e73aee5
2 changed files with 58 additions and 11 deletions

View File

@ -30,11 +30,6 @@ are.
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,12 +40,6 @@ are.
Optimize an LLVM bytecode file.
<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>
<dd>
Compile an LLVM bytecode program into native machine code.
@ -60,6 +49,22 @@ are.
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="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="llvm-prof.html"><b>llvm-prof</b></A>
<dd>
Transform raw '<tt>llvmprof.out</tt>' data into a human readable report.
<p>
</dl>
</td><td valign=top width=50%>

View File

@ -0,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>