From 84f82f7fac2735548eb6f800bd1fdeb4759f1c4b Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Mon, 28 Aug 2006 00:34:19 +0000 Subject: [PATCH] Excise references to the now defunct "analyze" tool. Merge descriptions where appropriate. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29931 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/Bugpoint.html | 2 +- docs/CommandGuide/analyze.pod | 75 ---------------------------------- docs/CommandGuide/bugpoint.pod | 2 +- docs/CommandGuide/index.html | 3 -- docs/CommandGuide/opt.pod | 38 +++++++++-------- docs/GettingStarted.html | 19 ++++----- docs/HowToSubmitABug.html | 4 +- docs/index.html | 1 - 8 files changed, 33 insertions(+), 111 deletions(-) delete mode 100644 docs/CommandGuide/analyze.pod diff --git a/docs/Bugpoint.html b/docs/Bugpoint.html index f60a7ea33af..1f295336706 100644 --- a/docs/Bugpoint.html +++ b/docs/Bugpoint.html @@ -124,7 +124,7 @@ flow graph, to reduce the size of the function as much as possible. Finally, bugpoint deletes any individual LLVM instructions whose absence does not eliminate the failure. At the end, bugpoint should tell you what passes crash, give you a bytecode file, and give you instructions on how to -reproduce the failure with opt, analyze, or llc.

+reproduce the failure with opt or llc.

diff --git a/docs/CommandGuide/analyze.pod b/docs/CommandGuide/analyze.pod deleted file mode 100644 index d5eff7ad881..00000000000 --- a/docs/CommandGuide/analyze.pod +++ /dev/null @@ -1,75 +0,0 @@ -=pod - -=head1 NAME - -analyze - LLVM program analyzer - -=head1 SYNOPSIS - -B [I] [I] - -=head1 DESCRIPTION - -The B 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 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 - -Load the specified dynamic object with name I. This file -should contain additional analysis passes that register themselves -with the B program after being loaded. - -After being loaded, additional command line options are made -available for running the passes made available by I. Use -B I B<-help> to see the new list of available -analysis passes. - -=item B<-profile-info-file> I - -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 succeeds, it will exit with 0. Otherwise, if an error -occurs, it will exit with a non-zero value. - -=head1 SEE ALSO - -L - -=head1 AUTHORS - -Maintained by the LLVM Team (L). - -=cut diff --git a/docs/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod index e9a8e87e25c..56f83953f22 100644 --- a/docs/CommandGuide/bugpoint.pod +++ b/docs/CommandGuide/bugpoint.pod @@ -114,7 +114,7 @@ if an error occurs, it will exit with a non-zero value. =head1 SEE ALSO -L, L +L =head1 AUTHOR diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 22fd85af9b7..349da742bef 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -51,9 +51,6 @@ options) arguments to the tool you are interested in.

  • llvm-link - link several bytecode files into one
    • -
  • analyze - - run LLVM analyses on a bytecode file and print the results
    • -
  • llvm-ar - archive bytecode files
    • diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index 6c149b69124..4134bfefb89 100644 --- a/docs/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod @@ -10,17 +10,25 @@ B [I] [I] =head1 DESCRIPTION -The B 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 B 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 depends on whether the B<-analyze> option is given. -The optimizations available via B 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. +When B<-analyze> is specified, B 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. -If no filename is specified on the command line, B reads its -input from standard input. +While B<-analyze> is I given, B attempts to produce an optimized +bytecode file. The optimizations available via B 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 I is omitted from the command line or is I<->, B 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 writes its output to the standard output. @@ -64,10 +72,10 @@ Manual>, section I<#DEBUG> for more information. =item B<-load>=I -Load the dynamic object I. 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. 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 @@ Print module after each transformation. If B succeeds, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value. -=head1 SEE ALSO - -L - =head1 AUTHORS Maintained by the LLVM Team (L). diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 5910ebc305f..085bc460b49 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -81,7 +81,7 @@ basic information.

    First, LLVM comes in two pieces. The first piece is the LLVM suite. This contains all of the tools, libraries, and header files needed to use the low level virtual machine. It contains an assembler, disassembler, bytecode -analyzer, and bytecode optimizer. It also contains a test suite that can be +analyzer and bytecode optimizer. It also contains a test suite that can be used to test the LLVM tools and the GCC front end.

    The second piece is the GCC front end. This component provides a version of @@ -1299,11 +1299,6 @@ following is a brief introduction to the most important tools. More detailed information is in the Command Guide.

    -
    analyze
    -
    analyze is used to run a specific - analysis on an input LLVM bytecode file and print out the results. It is - primarily useful for debugging analyses, or familiarizing yourself with - what an analysis does.
    bugpoint
    bugpoint is used to debug @@ -1395,11 +1390,13 @@ information is in the Command Guide.

    opt
    -
    opt reads LLVM bytecode, applies a - series of LLVM to LLVM transformations (which are specified on the command - line), and then outputs the resultant bytecode. The 'opt --help' - command is a good way to get a list of the program transformations - available in LLVM.
    +
    opt reads LLVM bytecode, applies a series of LLVM to LLVM + transformations (which are specified on the command line), and then outputs + the resultant bytecode. The 'opt --help' command is a good way to + get a list of the program transformations available in LLVM.
    +
    opt can also be used to run a specific analysis on an input + LLVM bytecode file and print out the results. It is primarily useful for + debugging analyses, or familiarizing yourself with what an analysis does.
    diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index ba24d988739..f01c5c72a10 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -82,8 +82,8 @@ information:

    More often than not, bugs in the compiler cause it to crash - often due to an -assertion failure of some sort. If you are running opt or -analyze directly, and something crashes, jump to the section on +assertion failure of some sort. If you are running opt +directly, and something crashes, jump to the section on bugs in LLVM passes. Otherwise, the most important piece of the puzzle is to figure out if it is the GCC-based front-end that is buggy or if it's one of the LLVM tools that has problems.

    diff --git a/docs/index.html b/docs/index.html index 367296b352f..a36aee9c4ef 100644 --- a/docs/index.html +++ b/docs/index.html @@ -75,7 +75,6 @@ Current tools: llc, lli, llvm-link, - analyze, llvm-nm, llvm-prof, llvmgcc,