From 7e7ae5ad692760aa8d97477f061a05b10948cf57 Mon Sep 17 00:00:00 2001 From: Duncan Sands Date: Thu, 18 Feb 2010 14:08:13 +0000 Subject: 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@96578 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/FileCheck.pod | 2 +- docs/CommandGuide/bugpoint.pod | 6 +++--- docs/CommandGuide/index.html | 2 +- docs/CommandGuide/llc.pod | 4 ++-- docs/CommandGuide/lli.pod | 2 +- docs/CommandGuide/llvm-as.pod | 2 +- docs/CommandGuide/llvm-bcanalyzer.pod | 2 +- docs/CommandGuide/llvm-config.pod | 2 +- docs/CommandGuide/llvm-dis.pod | 2 +- docs/CommandGuide/llvm-extract.pod | 2 +- docs/CommandGuide/llvm-link.pod | 2 +- docs/CommandGuide/llvm-nm.pod | 2 +- docs/CommandGuide/llvm-prof.pod | 2 +- docs/CommandGuide/llvm-ranlib.pod | 4 ++-- docs/CommandGuide/llvmc.pod | 4 ++-- docs/CommandGuide/tblgen.pod | 2 +- 16 files changed, 21 insertions(+), 21 deletions(-) (limited to 'docs/CommandGuide') diff --git a/docs/CommandGuide/FileCheck.pod b/docs/CommandGuide/FileCheck.pod index 32516ad..433979a 100644 --- a/docs/CommandGuide/FileCheck.pod +++ b/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/docs/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod index 204ea4d..7afeea1 100644 --- a/docs/CommandGuide/bugpoint.pod +++ b/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. -=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 into B 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 diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 9516d07..72cd2cf 100644 --- a/docs/CommandGuide/index.html +++ b/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 ---help (general options) or --help-hidden (general+debugging +-help (general options) or -help-hidden (general+debugging options) arguments to the tool you are interested in.

diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index 8adfb68..ac24aab 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -38,7 +38,7 @@ Other B 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 Specify the architecture for which to generate assembly, overriding the target -encoded in the input file. See the output of B for a list of +encoded in the input file. See the output of B for a list of valid architectures. By default this is inferred from the target triple or autodetected to the current architecture. diff --git a/docs/CommandGuide/lli.pod b/docs/CommandGuide/lli.pod index e9fdf74..3d5da3d 100644 --- a/docs/CommandGuide/lli.pod +++ b/docs/CommandGuide/lli.pod @@ -73,7 +73,7 @@ architecture which is not compatible with the current system. =item B<-march>=I Specify the architecture for which to generate assembly, overriding the target -encoded in the bitcode file. See the output of B for a list of +encoded in the bitcode file. See the output of B for a list of valid architectures. By default this is inferred from the target triple or autodetected to the current architecture. diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod index 045a924..185c009 100644 --- a/docs/CommandGuide/llvm-as.pod +++ b/docs/CommandGuide/llvm-as.pod @@ -50,7 +50,7 @@ Enable binary output on terminals. Normally, B will refuse to write raw bitcode output if the output stream is a terminal. With this option, B 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/docs/CommandGuide/llvm-bcanalyzer.pod b/docs/CommandGuide/llvm-bcanalyzer.pod index f60b513..b0bc0cd 100644 --- a/docs/CommandGuide/llvm-bcanalyzer.pod +++ b/docs/CommandGuide/llvm-bcanalyzer.pod @@ -43,7 +43,7 @@ Causes B 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/docs/CommandGuide/llvm-config.pod b/docs/CommandGuide/llvm-config.pod index 06f10de..4e38dae 100644 --- a/docs/CommandGuide/llvm-config.pod +++ b/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 arguments. diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod index 2b83290..5b2f4ef 100644 --- a/docs/CommandGuide/llvm-dis.pod +++ b/docs/CommandGuide/llvm-dis.pod @@ -33,7 +33,7 @@ Enable binary output on terminals. Normally, B will refuse to write raw bitcode output if the output stream is a terminal. With this option, B 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/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index 02f38ad..d4baab7 100644 --- a/docs/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod @@ -42,7 +42,7 @@ specified multiple times to extract multiple functions at once. Extract the global variable named I 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/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod index e1a1267..8d06cc9 100644 --- a/docs/CommandGuide/llvm-link.pod +++ b/docs/CommandGuide/llvm-link.pod @@ -51,7 +51,7 @@ Write output in LLVM intermediate language (instead of bitcode). If specified, B 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/docs/CommandGuide/llvm-nm.pod b/docs/CommandGuide/llvm-nm.pod index 995ac08..a580d3f 100644 --- a/docs/CommandGuide/llvm-nm.pod +++ b/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/docs/CommandGuide/llvm-prof.pod b/docs/CommandGuide/llvm-prof.pod index 381387d..9541b05 100644 --- a/docs/CommandGuide/llvm-prof.pod +++ b/docs/CommandGuide/llvm-prof.pod @@ -18,7 +18,7 @@ where the program hotspots are. This program is often used in conjunction with the F script. This script automatically instruments a program, runs it with the JIT, then runs B to format a report. To get more information about -F, execute it with the B<--help> option. +F, execute it with the B<-help> option. =head1 OPTIONS diff --git a/docs/CommandGuide/llvm-ranlib.pod b/docs/CommandGuide/llvm-ranlib.pod index 130edb0..53cd34b 100644 --- a/docs/CommandGuide/llvm-ranlib.pod +++ b/docs/CommandGuide/llvm-ranlib.pod @@ -6,7 +6,7 @@ llvm-ranlib - Generate index for LLVM archive =head1 SYNOPSIS -B [--version] [--help] +B [--version] [-help] =head1 DESCRIPTION @@ -30,7 +30,7 @@ Specifies the archive-file to which the symbol table is added or updated. Print the version of B and exit without building a symbol table. -=item F<--help> +=item F<-help> Print usage help for B and exit without building a symbol table. diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod index e5e0651..d237ca4 100644 --- a/docs/CommandGuide/llvmc.pod +++ b/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/docs/CommandGuide/tblgen.pod b/docs/CommandGuide/tblgen.pod index c8244af..d127492 100644 --- a/docs/CommandGuide/tblgen.pod +++ b/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. -- cgit v1.1