Renamed the link page to llvmlink.html
authorJohn Criswell <criswell@uiuc.edu>
Wed, 17 Sep 2003 14:11:24 +0000 (14:11 +0000)
committerJohn Criswell <criswell@uiuc.edu>
Wed, 17 Sep 2003 14:11:24 +0000 (14:11 +0000)
Added initial pages for the extract and llvm-link commands.
Reworded the description of the -load option for analyze to hopefully make it
more clear.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8575 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CommandGuide/analyze.html
docs/CommandGuide/extract.html [new file with mode: 0644]
docs/CommandGuide/index.html
docs/CommandGuide/llvm-link.html [new file with mode: 0644]

index 15a06392057b8f499998a5f15add803d8ca78cc6..25b93eb38d32f9a1e7270f66c0c1cea80cddc78f 100644 (file)
@@ -62,8 +62,8 @@ OPTIONS
        the analyze program after being loaded.
        <p>
        After being loaded, additional command line options are made available
-       for running additional analysis passes.  Use analyse -load
-       &lt;plugin.so&gt; -help to list the new list of available analysis
+       for running the passes made available by plugin.so.  Use analyse -load
+       &lt;plugin.so&gt; -help to see the new list of available analysis
        passes.
        <p>
 </ul>
diff --git a/docs/CommandGuide/extract.html b/docs/CommandGuide/extract.html
new file mode 100644 (file)
index 0000000..275b9b1
--- /dev/null
@@ -0,0 +1,74 @@
+<html>
+<title>
+extract
+</title>
+
+<body>
+
+<center>
+<h1>Low Level Virtual Machine</h1>
+</center>
+<HR>
+
+<h3>
+NAME
+</h3>
+
+extract
+
+<h3>
+SYNOPSIS
+</h3>
+
+extract [options] &lt;filename&gt; [filename ...]
+<h3>
+DESCRIPTION
+</h3>
+
+The extract command takes the name of a function and extracts it from the
+specified LLVM bytecode file.  It is primarily used as a debugging tool to
+reduce test cases from larger programs that are triggering a bug.
+
+<h3>
+OPTIONS
+</h3>
+
+<ul>
+       <li>-func &lt;function&gt;
+       <br>
+       Extract function from the LLVM bytecode.
+       <p>
+
+       <li> -help
+       <br>
+       Print a summary of command line options.
+       <p>
+
+       <li> -stats
+       <br>
+       Print statistics.
+       <p>
+
+       <li> -time-passes
+       <br>
+       Record the amount of time needed for each pass and print it to standard
+       error.
+</ul>
+
+<h3>
+EXIT STATUS
+</h3>
+
+If extract succeeds, it will exit with 0.  Otherwise, if an error occurs, it
+will exit with a non-zero value.
+
+<h3>
+SEE ALSO
+</h3>
+bugpoint
+
+<HR>
+<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
+</body>
+</html>
+
index 022e9eefb3268ebc23be64692090df1a253eefdf..cb6d3d2b8390d828ae3193565bda641fa503a5fc 100644 (file)
@@ -41,7 +41,7 @@
                Optimize an LLVM bytecode file.
                <p>
 
-               <dt><A href="link.html"><b>link</b></A>
+               <dt><A href="llvmlink.html"><b>llvm-link</b></A>
                <dd>
                Link several LLVM bytecode files together into one LLVM
                bytecode file.
diff --git a/docs/CommandGuide/llvm-link.html b/docs/CommandGuide/llvm-link.html
new file mode 100644 (file)
index 0000000..a503c2e
--- /dev/null
@@ -0,0 +1,91 @@
+<html>
+<title>
+llvm-link
+</title>
+
+<body>
+
+<center>
+<h1>Low Level Virtual Machine</h1>
+</center>
+<HR>
+
+<h3>
+NAME
+</h3>
+
+llvm-link
+
+<h3>
+SYNOPSIS
+</h3>
+
+llvm-link [options] &lt;filename&gt; [filename ...]
+<h3>
+DESCRIPTION
+</h3>
+
+The llvm-link command takes several LLVM bytecode files and links them together into a single LLVM bytecode file.
+
+<h3>
+OPTIONS
+</h3>
+
+<ul>
+       <li>-L &lt;pathname&gt;
+       <br>
+       Specify a library search path.  When looking for libraries, llvm-link
+       will look in pathname for libraries.  This option can be specified
+       multiple times; llvm-link will search inside these directories in the
+       order in which they were specified on the command line.
+       <p>
+
+       <li>-f
+       <br>
+       Overwrite output files.  By default, llvm-link will not overwrite an
+       output file if it alreadys exists.
+       <p>
+
+       <li>-o &lt;filename&gt;
+       <br>
+       Output filename.
+       <p>
+
+       <li> -help
+       <br>
+       Print a summary of command line options.
+       <p>
+
+       <li> -stats
+       <br>
+       Print statistics.
+       <p>
+
+       <li> -time-passes
+       <br>
+       Record the amount of time needed for each pass and print it to standard
+       error.
+       <p>
+
+       <li> -v
+       <br>
+       Verbose mode.  Print information about what llvm-link is doing.
+</ul>
+
+<h3>
+EXIT STATUS
+</h3>
+
+If llvm-link succeeds, it will exit with 0.  Otherwise, if an error occurs, it
+will exit with a non-zero value.
+
+<h3>
+SEE ALSO
+</h3>
+llvm-dis, lli
+
+<HR>
+<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
+</body>
+</html>
+