diff options
author | Duncan Sands <baldrick@free.fr> | 2010-02-18 14:08:13 +0000 |
---|---|---|
committer | Duncan Sands <baldrick@free.fr> | 2010-02-18 14:08:13 +0000 |
commit | 142b9edaf12346d77e5d58ab0b6bee821d6de458 (patch) | |
tree | 6cf819f97c79590819e12a5101bf8ad9ddb4df0e /llvm/docs/CommandGuide | |
parent | 26d19c59f86f00ed6651ff3889376a1a7259dcb0 (diff) | |
download | bcm5719-llvm-142b9edaf12346d77e5d58ab0b6bee821d6de458.tar.gz bcm5719-llvm-142b9edaf12346d77e5d58ab0b6bee821d6de458.zip |
Refer to -help instead of --help since this is what tools themselves say.
Also, have tools output -help-hidden rather than refer to --help-hidden,
for consistency, and likewise adjust documentation. This doesn't change
every mention of --help, only those which seemed clearly safe.
llvm-svn: 96578
Diffstat (limited to 'llvm/docs/CommandGuide')
-rw-r--r-- | llvm/docs/CommandGuide/FileCheck.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/bugpoint.pod | 6 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/index.html | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llc.pod | 4 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/lli.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-as.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-bcanalyzer.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-config.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-dis.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-extract.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-link.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-nm.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-prof.pod | 2 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-ranlib.pod | 4 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvmc.pod | 4 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/tblgen.pod | 2 |
16 files changed, 21 insertions, 21 deletions
diff --git a/llvm/docs/CommandGuide/FileCheck.pod b/llvm/docs/CommandGuide/FileCheck.pod index 32516ad87b3..433979a8719 100644 --- a/llvm/docs/CommandGuide/FileCheck.pod +++ b/llvm/docs/CommandGuide/FileCheck.pod @@ -25,7 +25,7 @@ match. The file to verify is always read from standard input. =over -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/bugpoint.pod b/llvm/docs/CommandGuide/bugpoint.pod index 204ea4d3d39..7afeea1aba5 100644 --- a/llvm/docs/CommandGuide/bugpoint.pod +++ b/llvm/docs/CommandGuide/bugpoint.pod @@ -85,7 +85,7 @@ mis-management. Continually randomize the specified passes and run them on the test program until a bug is found or the user kills B<bugpoint>. -=item B<--help> +=item B<-help> Print a summary of command line options. @@ -99,9 +99,9 @@ it runs, to come from that file. Load the dynamic object F<plugin> into B<bugpoint> itself. 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; for example: +optimizations, use the B<-help> and B<--load> options together; for example: - bugpoint --load myNewPass.so --help + bugpoint --load myNewPass.so -help =item B<--mlimit> F<megabytes> diff --git a/llvm/docs/CommandGuide/index.html b/llvm/docs/CommandGuide/index.html index 9516d075b3c..72cd2cf5f96 100644 --- a/llvm/docs/CommandGuide/index.html +++ b/llvm/docs/CommandGuide/index.html @@ -17,7 +17,7 @@ for all of the LLVM tools. These pages describe how to use the LLVM commands and what their options are. Note that these pages do not describe all of the options available for all tools. To get a complete listing, pass the -<tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging +<tt>-help</tt> (general options) or <tt>-help-hidden</tt> (general+debugging options) arguments to the tool you are interested in.</p> </div> diff --git a/llvm/docs/CommandGuide/llc.pod b/llvm/docs/CommandGuide/llc.pod index 8adfb682be0..ac24aab4ff6 100644 --- a/llvm/docs/CommandGuide/llc.pod +++ b/llvm/docs/CommandGuide/llc.pod @@ -38,7 +38,7 @@ Other B<llc> options are as follows: =over -=item B<--help> +=item B<-help> Print a summary of command line options. @@ -56,7 +56,7 @@ string. =item B<-march>=I<arch> Specify the architecture for which to generate assembly, overriding the target -encoded in the input file. See the output of B<llc --help> for a list of +encoded in the input file. See the output of B<llc -help> for a list of valid architectures. By default this is inferred from the target triple or autodetected to the current architecture. diff --git a/llvm/docs/CommandGuide/lli.pod b/llvm/docs/CommandGuide/lli.pod index e9fdf74fe53..3d5da3d465a 100644 --- a/llvm/docs/CommandGuide/lli.pod +++ b/llvm/docs/CommandGuide/lli.pod @@ -73,7 +73,7 @@ architecture which is not compatible with the current system. =item B<-march>=I<arch> Specify the architecture for which to generate assembly, overriding the target -encoded in the bitcode file. See the output of B<llc --help> for a list of +encoded in the bitcode file. See the output of B<llc -help> for a list of valid architectures. By default this is inferred from the target triple or autodetected to the current architecture. diff --git a/llvm/docs/CommandGuide/llvm-as.pod b/llvm/docs/CommandGuide/llvm-as.pod index 045a9245b60..185c009698f 100644 --- a/llvm/docs/CommandGuide/llvm-as.pod +++ b/llvm/docs/CommandGuide/llvm-as.pod @@ -50,7 +50,7 @@ Enable binary output on terminals. Normally, B<llvm-as> will refuse to write raw bitcode output if the output stream is a terminal. With this option, B<llvm-as> will write raw bitcode regardless of the output device. -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/llvm-bcanalyzer.pod b/llvm/docs/CommandGuide/llvm-bcanalyzer.pod index f60b5138221..b0bc0cddba8 100644 --- a/llvm/docs/CommandGuide/llvm-bcanalyzer.pod +++ b/llvm/docs/CommandGuide/llvm-bcanalyzer.pod @@ -43,7 +43,7 @@ Causes B<llvm-bcanalyzer> to verify the module produced by reading the bitcode. This ensures that the statistics generated are based on a consistent module. -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/llvm-config.pod b/llvm/docs/CommandGuide/llvm-config.pod index 06f10de2216..4e38dae3df6 100644 --- a/llvm/docs/CommandGuide/llvm-config.pod +++ b/llvm/docs/CommandGuide/llvm-config.pod @@ -30,7 +30,7 @@ To link against the JIT: Print the version number of LLVM. -=item B<--help> +=item B<-help> Print a summary of B<llvm-config> arguments. diff --git a/llvm/docs/CommandGuide/llvm-dis.pod b/llvm/docs/CommandGuide/llvm-dis.pod index 2b83290c9b2..5b2f4ef4e92 100644 --- a/llvm/docs/CommandGuide/llvm-dis.pod +++ b/llvm/docs/CommandGuide/llvm-dis.pod @@ -33,7 +33,7 @@ Enable binary output on terminals. Normally, B<llvm-dis> will refuse to write raw bitcode output if the output stream is a terminal. With this option, B<llvm-dis> will write raw bitcode regardless of the output device. -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/llvm-extract.pod b/llvm/docs/CommandGuide/llvm-extract.pod index 02f38adf554..d4baab73991 100644 --- a/llvm/docs/CommandGuide/llvm-extract.pod +++ b/llvm/docs/CommandGuide/llvm-extract.pod @@ -42,7 +42,7 @@ specified multiple times to extract multiple functions at once. Extract the global variable named I<global-name> from the LLVM bitcode. May be specified multiple times to extract multiple global variables at once. -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/llvm-link.pod b/llvm/docs/CommandGuide/llvm-link.pod index e1a1267c52e..8d06cc9d9d9 100644 --- a/llvm/docs/CommandGuide/llvm-link.pod +++ b/llvm/docs/CommandGuide/llvm-link.pod @@ -51,7 +51,7 @@ Write output in LLVM intermediate language (instead of bitcode). If specified, B<llvm-link> prints a human-readable version of the output bitcode file to standard error. -=item B<--help> +=item B<-help> Print a summary of command line options. diff --git a/llvm/docs/CommandGuide/llvm-nm.pod b/llvm/docs/CommandGuide/llvm-nm.pod index 995ac08139a..a580d3f5ca7 100644 --- a/llvm/docs/CommandGuide/llvm-nm.pod +++ b/llvm/docs/CommandGuide/llvm-nm.pod @@ -77,7 +77,7 @@ Use POSIX.2 output format. Alias for B<--format=posix>. Use BSD output format. Alias for B<--format=bsd>. -=item B<--help> +=item B<-help> Print a summary of command-line options and their meanings. diff --git a/llvm/docs/CommandGuide/llvm-prof.pod b/llvm/docs/CommandGuide/llvm-prof.pod index 381387d7dbe..9541b05dcaf 100644 --- a/llvm/docs/CommandGuide/llvm-prof.pod +++ b/llvm/docs/CommandGuide/llvm-prof.pod @@ -18,7 +18,7 @@ where the program hotspots are. This program is often used in conjunction with the F<utils/profile.pl> script. This script automatically instruments a program, runs it with the JIT, then runs B<llvm-prof> to format a report. To get more information about -F<utils/profile.pl>, execute it with the B<--help> option. +F<utils/profile.pl>, execute it with the B<-help> option. =head1 OPTIONS diff --git a/llvm/docs/CommandGuide/llvm-ranlib.pod b/llvm/docs/CommandGuide/llvm-ranlib.pod index 130edb07715..53cd34bbb5c 100644 --- a/llvm/docs/CommandGuide/llvm-ranlib.pod +++ b/llvm/docs/CommandGuide/llvm-ranlib.pod @@ -6,7 +6,7 @@ llvm-ranlib - Generate index for LLVM archive =head1 SYNOPSIS -B<llvm-ranlib> [--version] [--help] <archive-file> +B<llvm-ranlib> [--version] [-help] <archive-file> =head1 DESCRIPTION @@ -30,7 +30,7 @@ Specifies the archive-file to which the symbol table is added or updated. Print the version of B<llvm-ranlib> and exit without building a symbol table. -=item F<--help> +=item F<-help> Print usage help for B<llvm-ranlib> and exit without building a symbol table. diff --git a/llvm/docs/CommandGuide/llvmc.pod b/llvm/docs/CommandGuide/llvmc.pod index e5e06511613..d237ca4c14f 100644 --- a/llvm/docs/CommandGuide/llvmc.pod +++ b/llvm/docs/CommandGuide/llvmc.pod @@ -77,11 +77,11 @@ Store temporary files in the given directory. This directory is deleted on exit unless I<--save-temps> is specified. If I<--save-temps=obj> is also specified, I<--temp-dir> is given the precedence. -=item B<--help> +=item B<-help> Print a summary of command-line options and exit. -=item B<--help-hidden> +=item B<-help-hidden> Print a summary of command-line options and exit. Print help even for options intended for developers. diff --git a/llvm/docs/CommandGuide/tblgen.pod b/llvm/docs/CommandGuide/tblgen.pod index c8244af5cea..d127492a91b 100644 --- a/llvm/docs/CommandGuide/tblgen.pod +++ b/llvm/docs/CommandGuide/tblgen.pod @@ -26,7 +26,7 @@ to read as input. =over -=item B<--help> +=item B<-help> Print a summary of command line options. |