Documentation: improve formatting and remove unneeded empty lines.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168817 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko 2012-11-28 21:40:54 +00:00
parent 3d15a91777
commit 0215368887
2 changed files with 9 additions and 70 deletions

View File

@ -1,19 +1,15 @@
bugpoint - automatic test case reduction tool bugpoint - automatic test case reduction tool
============================================= =============================================
SYNOPSIS SYNOPSIS
-------- --------
**bugpoint** [*options*] [*input LLVM ll/bc files*] [*LLVM passes*] **--args** **bugpoint** [*options*] [*input LLVM ll/bc files*] [*LLVM passes*] **--args**
*program arguments* *program arguments*
DESCRIPTION DESCRIPTION
----------- -----------
**bugpoint** narrows down the source of problems in LLVM tools and passes. It **bugpoint** narrows down the source of problems in LLVM tools and passes. It
can be used to debug three types of failures: optimizer crashes, miscompilations can be used to debug three types of failures: optimizer crashes, miscompilations
by optimizers, or bad native code generation (including problems in the static by optimizers, or bad native code generation (including problems in the static
@ -22,82 +18,61 @@ For more information on the design and inner workings of **bugpoint**, as well a
advice for using bugpoint, see *llvm/docs/Bugpoint.html* in the LLVM advice for using bugpoint, see *llvm/docs/Bugpoint.html* in the LLVM
distribution. distribution.
OPTIONS OPTIONS
------- -------
**--additional-so** *library* **--additional-so** *library*
Load the dynamic shared object *library* into the test program whenever it is Load the dynamic shared object *library* into the test program whenever it is
run. This is useful if you are debugging programs which depend on non-LLVM run. This is useful if you are debugging programs which depend on non-LLVM
libraries (such as the X or curses libraries) to run. libraries (such as the X or curses libraries) to run.
**--append-exit-code**\ =\ *{true,false}* **--append-exit-code**\ =\ *{true,false}*
Append the test programs exit code to the output file so that a change in exit Append the test programs exit code to the output file so that a change in exit
code is considered a test failure. Defaults to false. code is considered a test failure. Defaults to false.
**--args** *program args* **--args** *program args*
Pass all arguments specified after -args to the test program whenever it runs. Pass all arguments specified after **--args** to the test program whenever it runs.
Note that if any of the *program args* start with a '-', you should use: Note that if any of the *program args* start with a "``-``", you should use:
.. code-block:: perl .. code-block:: perl
bugpoint [bugpoint args] --args -- [program args] bugpoint [bugpoint args] --args -- [program args]
The "``--``" right after the **--args** option tells **bugpoint** to consider
The "--" right after the **--args** option tells **bugpoint** to consider any any options starting with "``-``" to be part of the **--args** option, not as
options starting with ``-`` to be part of the **--args** option, not as options to options to **bugpoint** itself.
**bugpoint** itself.
**--tool-args** *tool args* **--tool-args** *tool args*
Pass all arguments specified after --tool-args to the LLVM tool under test Pass all arguments specified after **--tool-args** to the LLVM tool under test
(**llc**, **lli**, etc.) whenever it runs. You should use this option in the (**llc**, **lli**, etc.) whenever it runs. You should use this option in the
following way: following way:
.. code-block:: perl .. code-block:: perl
bugpoint [bugpoint args] --tool-args -- [tool args] bugpoint [bugpoint args] --tool-args -- [tool args]
The "``--``" right after the **--tool-args** option tells **bugpoint** to
The "--" right after the **--tool-args** option tells **bugpoint** to consider any consider any options starting with "``-``" to be part of the **--tool-args**
options starting with ``-`` to be part of the **--tool-args** option, not as option, not as options to **bugpoint** itself. (See **--args**, above.)
options to **bugpoint** itself. (See **--args**, above.)
**--safe-tool-args** *tool args* **--safe-tool-args** *tool args*
Pass all arguments specified after **--safe-tool-args** to the "safe" execution Pass all arguments specified after **--safe-tool-args** to the "safe" execution
tool. tool.
**--gcc-tool-args** *gcc tool args* **--gcc-tool-args** *gcc tool args*
Pass all arguments specified after **--gcc-tool-args** to the invocation of Pass all arguments specified after **--gcc-tool-args** to the invocation of
**gcc**. **gcc**.
**--opt-args** *opt args* **--opt-args** *opt args*
Pass all arguments specified after **--opt-args** to the invocation of **opt**. Pass all arguments specified after **--opt-args** to the invocation of **opt**.
**--disable-{dce,simplifycfg}** **--disable-{dce,simplifycfg}**
Do not run the specified passes to clean up and reduce the size of the test Do not run the specified passes to clean up and reduce the size of the test
@ -105,36 +80,26 @@ OPTIONS
reduce test programs. If you're trying to find a bug in one of these passes, reduce test programs. If you're trying to find a bug in one of these passes,
**bugpoint** may crash. **bugpoint** may crash.
**--enable-valgrind** **--enable-valgrind**
Use valgrind to find faults in the optimization phase. This will allow Use valgrind to find faults in the optimization phase. This will allow
bugpoint to find otherwise asymptomatic problems caused by memory bugpoint to find otherwise asymptomatic problems caused by memory
mis-management. mis-management.
**-find-bugs** **-find-bugs**
Continually randomize the specified passes and run them on the test program Continually randomize the specified passes and run them on the test program
until a bug is found or the user kills **bugpoint**. until a bug is found or the user kills **bugpoint**.
**-help** **-help**
Print a summary of command line options. Print a summary of command line options.
**--input** *filename* **--input** *filename*
Open *filename* and redirect the standard input of the test program, whenever Open *filename* and redirect the standard input of the test program, whenever
it runs, to come from that file. it runs, to come from that file.
**--load** *plugin* **--load** *plugin*
Load the dynamic object *plugin* into **bugpoint** itself. This object should Load the dynamic object *plugin* into **bugpoint** itself. This object should
@ -147,16 +112,11 @@ OPTIONS
bugpoint --load myNewPass.so -help bugpoint --load myNewPass.so -help
**--mlimit** *megabytes* **--mlimit** *megabytes*
Specifies an upper limit on memory usage of the optimization and codegen. Set Specifies an upper limit on memory usage of the optimization and codegen. Set
to zero to disable the limit. to zero to disable the limit.
**--output** *filename* **--output** *filename*
Whenever the test program produces output on its standard output stream, it Whenever the test program produces output on its standard output stream, it
@ -164,14 +124,10 @@ OPTIONS
do not use this option, **bugpoint** will attempt to generate a reference output do not use this option, **bugpoint** will attempt to generate a reference output
by compiling the program with the "safe" backend and running it. by compiling the program with the "safe" backend and running it.
**--profile-info-file** *filename* **--profile-info-file** *filename*
Profile file loaded by **--profile-loader**. Profile file loaded by **--profile-loader**.
**--run-{int,jit,llc,custom}** **--run-{int,jit,llc,custom}**
Whenever the test program is compiled, **bugpoint** should generate code for it Whenever the test program is compiled, **bugpoint** should generate code for it
@ -179,8 +135,6 @@ OPTIONS
interpreter, the JIT compiler, the static native code compiler, or a interpreter, the JIT compiler, the static native code compiler, or a
custom command (see **--exec-command**) respectively. custom command (see **--exec-command**) respectively.
**--safe-{llc,custom}** **--safe-{llc,custom}**
When debugging a code generator, **bugpoint** should use the specified code When debugging a code generator, **bugpoint** should use the specified code
@ -192,16 +146,12 @@ OPTIONS
respectively. The interpreter and the JIT backends cannot currently respectively. The interpreter and the JIT backends cannot currently
be used as the "safe" backends. be used as the "safe" backends.
**--exec-command** *command* **--exec-command** *command*
This option defines the command to use with the **--run-custom** and This option defines the command to use with the **--run-custom** and
**--safe-custom** options to execute the bitcode testcase. This can **--safe-custom** options to execute the bitcode testcase. This can
be useful for cross-compilation. be useful for cross-compilation.
**--compile-command** *command* **--compile-command** *command*
This option defines the command to use with the **--compile-custom** This option defines the command to use with the **--compile-custom**
@ -210,38 +160,28 @@ OPTIONS
generate a reduced unit test, you may add CHECK directives to the generate a reduced unit test, you may add CHECK directives to the
testcase and pass the name of an executable compile-command script in this form: testcase and pass the name of an executable compile-command script in this form:
.. code-block:: sh .. code-block:: sh
#!/bin/sh #!/bin/sh
llc "$@" llc "$@"
not FileCheck [bugpoint input file].ll < bugpoint-test-program.s not FileCheck [bugpoint input file].ll < bugpoint-test-program.s
This script will "fail" as long as FileCheck passes. So the result This script will "fail" as long as FileCheck passes. So the result
will be the minimum bitcode that passes FileCheck. will be the minimum bitcode that passes FileCheck.
**--safe-path** *path* **--safe-path** *path*
This option defines the path to the command to execute with the This option defines the path to the command to execute with the
**--safe-{int,jit,llc,custom}** **--safe-{int,jit,llc,custom}**
option. option.
EXIT STATUS EXIT STATUS
----------- -----------
If **bugpoint** succeeds in finding a problem, it will exit with 0. Otherwise, If **bugpoint** succeeds in finding a problem, it will exit with 0. Otherwise,
if an error occurs, it will exit with a non-zero value. if an error occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
opt|opt opt|opt

View File

@ -7,7 +7,6 @@ System Library
Abstract Abstract
======== ========
This document provides some details on LLVM's System Library, located in the This document provides some details on LLVM's System Library, located in the
source at ``lib/System`` and ``include/llvm/System``. The library's purpose is source at ``lib/System`` and ``include/llvm/System``. The library's purpose is
to shield LLVM from the differences between operating systems for the few to shield LLVM from the differences between operating systems for the few