[llvm-commits] CVS: llvm/www/docs/CommandGuide/llvmlink.html opt.html

[John Criswell]

Changes in directory llvm/www/docs/CommandGuide:

llvmlink.html updated: 1.2 -> 1.3
opt.html updated: 1.3 -> 1.4

---
Log message:

Added information on how input and output files are selected.
Added information on where files are located by llvm-link.
Added missing options.
Re-worded some stuff so that it (hopefully) sounds better.


---
Diffs of the changes:

Index: llvm/www/docs/CommandGuide/llvmlink.html
diff -u llvm/www/docs/CommandGuide/llvmlink.html:1.2 llvm/www/docs/CommandGuide/llvmlink.html:1.3
--- llvm/www/docs/CommandGuide/llvmlink.html:1.2	Thu Sep 25 14:50:05 2003
+++ llvm/www/docs/CommandGuide/llvmlink.html	Fri Sep 26 11:32:00 2003
@@ -25,19 +25,29 @@
 DESCRIPTION
 </h3>
 
-The llvm-link command takes several LLVM bytecode files and links them together into a single LLVM bytecode file.
+The llvm-link command takes several LLVM bytecode files and links them together
+into a single LLVM bytecode file.  It writes the output file to standard
+output, unless the -o option is used to specify a filename.
+<p>
+
+The llvm-link command attempts to load the input files from the current
+directory.  If that fails, it attempts to locate each file within the
+directories specified by the -L options on the command line.  The library
+search paths are global; each one is search for every input file if necessary.
+The directories are searched in the order they were specified on the command
+line.
 
 <h3>
 OPTIONS
 </h3>
 
 <ul>
-	<li>-L <pathname>
+	<li>-L <directory>
 	<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.
+	Add the specified directory to the 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
@@ -48,26 +58,33 @@
 
 	<li>-o <filename>
 	<br>
-	Output filename.
+	Output filename.  If filename is -, then llvm-link will write its output to
+	standard output.
 	<p>
 
-	<li> -help
+	<li>-d
+	<br>
+	If specified, llvm-link prints a human readable version of the output
+	bytecode file to standard error.
+	<p>
+
+	<li>-help
 	<br>
 	Print a summary of command line options.
 	<p>
 
-	<li> -stats
+	<li>-stats
 	<br>
 	Print statistics.
 	<p>
 
-	<li> -time-passes
+	<li>-time-passes
 	<br>
 	Record the amount of time needed for each pass and print it to standard
 	error.
 	<p>
 
-	<li> -v
+	<li>-v
 	<br>
 	Verbose mode.  Print information about what llvm-link is doing.
 </ul>
@@ -82,7 +99,7 @@
 <h3>
 SEE ALSO
 </h3>
-llvm-dis, lli
+llvm-dis, lli, gccld
 
 <HR>
 <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>


Index: llvm/www/docs/CommandGuide/opt.html
diff -u llvm/www/docs/CommandGuide/opt.html:1.3 llvm/www/docs/CommandGuide/opt.html:1.4
--- llvm/www/docs/CommandGuide/opt.html:1.3	Thu Sep 25 14:50:05 2003
+++ llvm/www/docs/CommandGuide/opt.html	Fri Sep 26 11:32:00 2003
@@ -20,19 +20,27 @@
 SYNOPSIS
 </h3>
 
-opt [options] < filename>
+opt [options] [filename]
 <h3>
 DESCRIPTION
 </h3>
 
 The opt command is the LLVM optimizer.  It takes LLVM bytecode as input, runs
-the specified optimizations on it, and then outputs the optimized code in LLVM
+the specified optimizations on it, and then outputs the optimized LLVM
 bytecode.
+<p>
 
-The optimizations available via opt depend upon what libraries it was linked
-with, as well as any additional libraries that have been loaded with the -load
-option.  Use the -help option to determine what optimizations you can use.
+The optimizations available via opt depend upon what libraries were linked
+into it as well as any additional libraries that have been loaded with the
+-load option.  Use the -help option to determine what optimizations you can use.
+<p>
 
+If no filename is specified on the command line, opt reads its input from
+standard input.
+<p>
+
+If an output filename is not specified with the -o option, opt writes its
+output to the standard output.
 <h3>
 OPTIONS
 </h3>