From: Misha Brukman <brukman+llvm@gmail.com>
Date: Thu, 1 Jul 2004 15:25:04 +0000 (+0000)
Subject: Fresh from the LLVM baker's oven: opt and analyze pods.
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=6998517a9cac5f51bba6c02f09acee945ffb9c0f;p=oota-llvm.git

Fresh from the LLVM baker's oven: opt and analyze pods.


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

diff --git a/docs/CommandGuide/analyze.pod b/docs/CommandGuide/analyze.pod
new file mode 100644
index 00000000000..3df0898760c
--- /dev/null
+++ b/docs/CommandGuide/analyze.pod
@@ -0,0 +1,78 @@
+
+=pod
+
+=head1 NAME
+
+analyze - LLVM program analyzer
+
+=head1 SYNOPSIS
+
+analyze [options] [filename]
+
+=head1 DESCRIPTION
+
+The B<analyze> command performs various analysis of LLVM assembly
+code or 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.
+
+If filename is omitted or is I<->, B<analyze> reads its input from
+standard input.  It first attempts to interpret its input as LLVM
+bytecode.  If it encounters an error, it then attempts to parse the
+input as LLVM assembly language.
+
+=head1 OPTIONS
+
+=over
+
+=item B<-help>
+
+Print a summary of command line options.
+
+=item B<-q>
+
+Quiet mode.  With this option, analysis pass names are not printed.
+
+=item B<-load> I<plugin>
+
+Load the specified dynamic object with name I<plugin>.  This file
+should contain additional analysis passes that register themselves
+with the B<analyze> program after being loaded.
+
+After being loaded, additional command line options are made
+available for running the passes made available by I<plugin>.  Use
+B<analyze -load> I<plugin> B<-help> to see the new list of available
+analysis passes.
+
+=item B<-profile-info-file> I<filename>
+
+Specify the name of the file loaded by the -profile-loader option.
+
+=item B<-stats>
+
+Print statistics.
+
+=item B<-time-passes>
+
+Record the amount of time needed for each pass and print it to standard
+error.
+
+=back
+
+=head1 EXIT STATUS
+
+If B<analyze> succeeds, it will exit with 0.  Otherwise, if an error
+occurs, it will exit with a non-zero value.
+
+=head1 SEE ALSO
+
+L<opt>
+
+=head1 AUTHORS
+
+Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
+
+=cut
+
+
diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod
new file mode 100644
index 00000000000..bd27ec17f95
--- /dev/null
+++ b/docs/CommandGuide/opt.pod
@@ -0,0 +1,99 @@
+
+=pod
+
+=head1 NAME
+
+opt - LLVM optimizer
+
+=head1 SYNOPSIS
+
+opt [options] [filename]
+
+=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.
+
+If no filename is specified on the command line, B<opt> reads its
+input from standard input.
+
+If an output filename is not specified with the B<-o> option, B<opt>
+writes its output to the standard output.
+
+=head1 OPTIONS
+
+=over
+
+=item B<-f>
+
+Force overwrite.  Normally, B<opt> will refuse to overwrite an
+output file that already exists.  With this option, B<opt> will
+overwrite the output file and replace it with new bytecode.
+
+=item B<-help>
+
+Print a summary of command line options.
+
+=item B<-o> I<filename>
+
+Specify the output filename.
+
+=item B<-profile-info-file> I<filename>
+
+Specify the name of the file loaded by the -profile-loader option.
+
+=item B<-stats>
+
+Print statistics.
+
+=item B<-time-passes>
+
+Record the amount of time needed for each pass and print it to standard
+error.
+
+=item B<-debug>
+
+If this is a debug build, this option will enable debug printouts
+from passes which use the I<DEBUG()> macro.  See the B<LLVM Programmer's
+Manual>, section I<#DEBUG> for more information.
+
+=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:
+
+=over
+
+B<opt -load>=I<plugin> B<-help>
+
+=back
+
+=item B<-p>
+
+Print module after each transformation.
+
+=back
+
+=head1 EXIT STATUS
+
+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>
+
+=head1 AUTHORS
+
+Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
+
+=cut
+