[llvm-commits] CVS: llvm/docs/CommandGuide/bugpoint.pod index.html opt.pod analyze.pod

[Reid Spencer]

Changes in directory llvm/docs/CommandGuide:

bugpoint.pod updated: 1.8 -> 1.9
index.html updated: 1.28 -> 1.29
opt.pod updated: 1.3 -> 1.4
analyze.pod (r1.3) removed
---
Log message:

Excise references to the now defunct "analyze" tool. Merge descriptions
where appropriate.


---
Diffs of the changes:  (+24 -23)

 bugpoint.pod |    2 +-
 index.html   |    5 +----
 opt.pod      |   40 ++++++++++++++++++++++------------------
 3 files changed, 24 insertions(+), 23 deletions(-)


Index: llvm/docs/CommandGuide/bugpoint.pod
diff -u llvm/docs/CommandGuide/bugpoint.pod:1.8 llvm/docs/CommandGuide/bugpoint.pod:1.9
--- llvm/docs/CommandGuide/bugpoint.pod:1.8	Tue Aug 15 12:39:40 2006
+++ llvm/docs/CommandGuide/bugpoint.pod	Sun Aug 27 19:34:19 2006
@@ -114,7 +114,7 @@
 
 =head1 SEE ALSO
 
-L<opt|opt>, L<analyze|analyze>
+L<opt|opt>
 
 =head1 AUTHOR
 


Index: llvm/docs/CommandGuide/index.html
diff -u llvm/docs/CommandGuide/index.html:1.28 llvm/docs/CommandGuide/index.html:1.29
--- llvm/docs/CommandGuide/index.html:1.28	Fri Jun  2 12:43:38 2006
+++ llvm/docs/CommandGuide/index.html	Sun Aug 27 19:34:19 2006
@@ -51,9 +51,6 @@
 <li><a href="html/llvm-link.html"><b>llvm-link</b></a> -
     link several bytecode files into one</li>
 
-<li><a href="html/analyze.html"><b>analyze</b></a> -
-    run LLVM analyses on a bytecode file and print the results</li>
-
 <li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> - 
     archive bytecode files</li>
 
@@ -159,7 +156,7 @@
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 
   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2006/06/02 17:43:38 $
+  Last modified: $Date: 2006/08/28 00:34:19 $
 </address>
 
 </body>


Index: llvm/docs/CommandGuide/opt.pod
diff -u llvm/docs/CommandGuide/opt.pod:1.3 llvm/docs/CommandGuide/opt.pod:1.4
--- llvm/docs/CommandGuide/opt.pod:1.3	Mon Mar 13 23:42:07 2006
+++ llvm/docs/CommandGuide/opt.pod	Sun Aug 27 19:34:19 2006
@@ -10,17 +10,25 @@
 
 =head1 DESCRIPTION
 
-The B<opt> command is the modular LLVM optimizer.  It takes LLVM
-bytecode as input, runs the specified optimizations on it, and then
-outputs the optimized LLVM bytecode.
-
-The optimizations available via B<opt> depend upon what libraries
-were linked into it as well as any additional libraries that have
-been loaded with the B<-load> option.  Use the B<-help> option to
-determine what optimizations you can use.
+The B<opt> command is the modular LLVM optimizer and analyzer.  It takes LLVM 
+bytecode as input, runs the specified optimizations or analyses on it, and then
+outputs the optimized LLVM bytecode or the analysis results.  The function of 
+B<opt> depends on whether the B<-analyze> option is given. 
+
+When B<-analyze> is specified, B<opt> performs various analyses of LLVM 
+bytecode.  It will usually print the results on standard output, but in a few 
+cases, it will print output to standard error or generate a file with the 
+analysis output, which is usually done when the output is meant for another 
+program.  
+
+While B<-analyze> is I<not> given, B<opt> attempts to produce an optimized 
+bytecode file.  The optimizations available via B<opt> depend upon what 
+libraries were linked into it as well as any additional libraries that have 
+been loaded with the B<-load> option.  Use the B<-help> option to determine 
+what optimizations you can use.
 
-If no filename is specified on the command line, B<opt> reads its
-input from standard input.
+If I<filename> is omitted from the command line or is I<->, B<opt> reads its
+input from standard input. The input must be an LLVM bytecode file.
 
 If an output filename is not specified with the B<-o> option, B<opt>
 writes its output to the standard output.
@@ -64,10 +72,10 @@
 
 =item B<-load>=I<plugin>
 
-Load the dynamic object I<plugin>.  This object should register new
-optimization passes.  Once loaded, the object will add new command line
-options to enable various optimizations.  To see the new complete list
-of optimizations, use the B<-help> and B<-load> options together:
+Load the dynamic object I<plugin>.  This object should register new optimization
+or analysis passes. Once loaded, the object will add new command line options to
+enable various optimizations or analyses.  To see the new complete list of 
+optimizations, use the B<-help> and B<-load> options together. For example:
 
 =over
 
@@ -86,10 +94,6 @@
 If B<opt> succeeds, it will exit with 0.  Otherwise, if an error
 occurs, it will exit with a non-zero value.
 
-=head1 SEE ALSO
-
-L<analyze|analyze>
-
 =head1 AUTHORS
 
 Maintained by the LLVM Team (L<http://llvm.org>).