mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2025-02-25 03:30:37 +00:00
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
This commit is contained in:
parent
3460f221cd
commit
7e7ae5ad69
@ -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.
|
||||
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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>
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
@ -26,7 +26,7 @@ to read as input.
|
||||
|
||||
=over
|
||||
|
||||
=item B<--help>
|
||||
=item B<-help>
|
||||
|
||||
Print a summary of command line options.
|
||||
|
||||
|
@ -44,7 +44,7 @@
|
||||
|
||||
<li><a href="#modifiers">Option Modifiers</a>
|
||||
<ul>
|
||||
<li><a href="#hiding">Hiding an option from <tt>--help</tt>
|
||||
<li><a href="#hiding">Hiding an option from <tt>-help</tt>
|
||||
output</a></li>
|
||||
<li><a href="#numoccurrences">Controlling the number of occurrences
|
||||
required and allowed</a></li>
|
||||
@ -161,7 +161,7 @@ you declare it. <a href="#customparser">Custom parsers</a> are no problem.</li>
|
||||
|
||||
<li>Labor Saving: The CommandLine library cuts down on the amount of grunt work
|
||||
that you, the user, have to do. For example, it automatically provides a
|
||||
<tt>--help</tt> option that shows the available command line options for your
|
||||
<tt>-help</tt> option that shows the available command line options for your
|
||||
tool. Additionally, it does most of the basic correctness checking for
|
||||
you.</li>
|
||||
|
||||
@ -239,14 +239,14 @@ href="#list">"<tt>cl::list</tt> template</a>), and tell the CommandLine library
|
||||
that the data type that we are parsing is a string.</p>
|
||||
|
||||
<p>The second and third parameters (which are optional) are used to specify what
|
||||
to output for the "<tt>--help</tt>" option. In this case, we get a line that
|
||||
to output for the "<tt>-help</tt>" option. In this case, we get a line that
|
||||
looks like this:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: compiler [options]
|
||||
|
||||
OPTIONS:
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
<b>-o <filename> - Specify output filename</b>
|
||||
</pre></div>
|
||||
|
||||
@ -308,14 +308,14 @@ the CommandLine library will automatically issue an error if the argument is not
|
||||
specified, which shifts all of the command line option verification code out of
|
||||
your application into the library. This is just one example of how using flags
|
||||
can alter the default behaviour of the library, on a per-option basis. By
|
||||
adding one of the declarations above, the <tt>--help</tt> option synopsis is now
|
||||
adding one of the declarations above, the <tt>-help</tt> option synopsis is now
|
||||
extended to:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: compiler [options] <b><input file></b>
|
||||
|
||||
OPTIONS:
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
-o <filename> - Specify output filename
|
||||
</pre></div>
|
||||
|
||||
@ -346,8 +346,8 @@ declaring options of boolean type like this:</p>
|
||||
("<tt>Force</tt>", "<tt>Quiet</tt>", and "<tt>Quiet2</tt>") to recognize these
|
||||
options. Note that the "<tt>-q</tt>" option is specified with the "<a
|
||||
href="#cl::Hidden"><tt>cl::Hidden</tt></a>" flag. This modifier prevents it
|
||||
from being shown by the standard "<tt>--help</tt>" output (note that it is still
|
||||
shown in the "<tt>--help-hidden</tt>" output).</p>
|
||||
from being shown by the standard "<tt>-help</tt>" output (note that it is still
|
||||
shown in the "<tt>-help-hidden</tt>" output).</p>
|
||||
|
||||
<p>The CommandLine library uses a <a href="#builtinparsers">different parser</a>
|
||||
for different data types. For example, in the string case, the argument passed
|
||||
@ -372,7 +372,7 @@ href="#doubleparser">double</a>, and <a href="#intparser">int</a> parsers work
|
||||
like you would expect, using the '<tt>strtol</tt>' and '<tt>strtod</tt>' C
|
||||
library calls to parse the string value into the specified data type.</p>
|
||||
|
||||
<p>With the declarations above, "<tt>compiler --help</tt>" emits this:</p>
|
||||
<p>With the declarations above, "<tt>compiler -help</tt>" emits this:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: compiler [options] <input file>
|
||||
@ -381,10 +381,10 @@ OPTIONS:
|
||||
<b>-f - Enable binary output on terminals</b>
|
||||
-o - Override output filename
|
||||
<b>-quiet - Don't print informational messages</b>
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
</pre></div>
|
||||
|
||||
<p>and "<tt>compiler --help-hidden</tt>" prints this:</p>
|
||||
<p>and "<tt>compiler -help-hidden</tt>" prints this:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: compiler [options] <input file>
|
||||
@ -394,7 +394,7 @@ OPTIONS:
|
||||
-o - Override output filename
|
||||
<b>-q - Don't print informational messages</b>
|
||||
-quiet - Don't print informational messages
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
</pre></div>
|
||||
|
||||
<p>This brief example has shown you how to use the '<tt><a
|
||||
@ -438,7 +438,7 @@ the <tt><a href="#cl::aliasopt">cl::aliasopt</a></tt> modifier) whenever it is
|
||||
specified. Because aliases do not hold state, the only thing the program has to
|
||||
query is the <tt>Quiet</tt> variable now. Another nice feature of aliases is
|
||||
that they automatically hide themselves from the <tt>-help</tt> output
|
||||
(although, again, they are still visible in the <tt>--help-hidden
|
||||
(although, again, they are still visible in the <tt>-help-hidden
|
||||
output</tt>).</p>
|
||||
|
||||
<p>Now the application code can simply use:</p>
|
||||
@ -531,7 +531,7 @@ OPTIONS:
|
||||
-O2 - Enable default optimizations
|
||||
-O3 - Enable expensive optimizations</b>
|
||||
-f - Enable binary output on terminals
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
-o <filename> - Specify output filename
|
||||
-quiet - Don't print informational messages
|
||||
</pre></div>
|
||||
@ -599,7 +599,7 @@ enum DebugLev {
|
||||
<p>This definition defines an enumerated command line variable of type "<tt>enum
|
||||
DebugLev</tt>", which works exactly the same way as before. The difference here
|
||||
is just the interface exposed to the user of your program and the help output by
|
||||
the "<tt>--help</tt>" option:</p>
|
||||
the "<tt>-help</tt>" option:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: compiler [options] <input file>
|
||||
@ -615,7 +615,7 @@ OPTIONS:
|
||||
=quick - enable quick debug information
|
||||
=detailed - enable detailed debug information</b>
|
||||
-f - Enable binary output on terminals
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
-o <filename> - Specify output filename
|
||||
-quiet - Don't print informational messages
|
||||
</pre></div>
|
||||
@ -794,7 +794,7 @@ USAGE: compiler [options] <input file>
|
||||
|
||||
OPTIONS:
|
||||
...
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
-o <filename> - Specify output filename
|
||||
</pre></div>
|
||||
|
||||
@ -835,14 +835,14 @@ Using the CommandLine library, this would be specified as:</p>
|
||||
<a href="#cl::opt">cl::opt</a><string> Filename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i><input file></i>"), <a href="#cl::init">cl::init</a>("<i>-</i>"));
|
||||
</pre></div>
|
||||
|
||||
<p>Given these two option declarations, the <tt>--help</tt> output for our grep
|
||||
<p>Given these two option declarations, the <tt>-help</tt> output for our grep
|
||||
replacement would look like this:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
USAGE: spiffygrep [options] <b><regular expression> <input file></b>
|
||||
|
||||
OPTIONS:
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
</pre></div>
|
||||
|
||||
<p>... and the resultant program could be used just like the standard
|
||||
@ -872,7 +872,7 @@ Note that the system <tt>grep</tt> has the same problem:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
$ spiffygrep '-foo' test.txt
|
||||
Unknown command line argument '-foo'. Try: spiffygrep --help'
|
||||
Unknown command line argument '-foo'. Try: spiffygrep -help'
|
||||
|
||||
$ grep '-foo' test.txt
|
||||
grep: illegal option -- f
|
||||
@ -986,7 +986,7 @@ shell itself. Using the CommandLine library, we would specify this as:</p>
|
||||
USAGE: spiffysh [options] <b><input script> <program arguments>...</b>
|
||||
|
||||
OPTIONS:
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
<b>-x - Enable trace output</b>
|
||||
</pre></div>
|
||||
|
||||
@ -1098,11 +1098,11 @@ This option is specified in simple double quotes:
|
||||
</li>
|
||||
|
||||
<li><a name="cl::desc">The <b><tt>cl::desc</tt></b></a> attribute specifies a
|
||||
description for the option to be shown in the <tt>--help</tt> output for the
|
||||
description for the option to be shown in the <tt>-help</tt> output for the
|
||||
program.</li>
|
||||
|
||||
<li><a name="cl::value_desc">The <b><tt>cl::value_desc</tt></b></a> attribute
|
||||
specifies a string that can be used to fine tune the <tt>--help</tt> output for
|
||||
specifies a string that can be used to fine tune the <tt>-help</tt> output for
|
||||
a command line option. Look <a href="#value_desc_example">here</a> for an
|
||||
example.</li>
|
||||
|
||||
@ -1130,7 +1130,7 @@ the string-to-value mapping to be used by the generic parser. It takes a
|
||||
<b>clEnumValEnd terminated</b> list of (option, value, description) triplets
|
||||
that
|
||||
specify the option name, the value mapped to, and the description shown in the
|
||||
<tt>--help</tt> for the tool. Because the generic parser is used most
|
||||
<tt>-help</tt> for the tool. Because the generic parser is used most
|
||||
frequently with enum values, two macros are often useful:
|
||||
|
||||
<ol>
|
||||
@ -1175,13 +1175,13 @@ obviously).</li>
|
||||
<p>Option modifiers are the flags and expressions that you pass into the
|
||||
constructors for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
|
||||
href="#cl::list">cl::list</a></tt>. These modifiers give you the ability to
|
||||
tweak how options are parsed and how <tt>--help</tt> output is generated to fit
|
||||
tweak how options are parsed and how <tt>-help</tt> output is generated to fit
|
||||
your application well.</p>
|
||||
|
||||
<p>These options fall into five main categories:</p>
|
||||
|
||||
<ol>
|
||||
<li><a href="#hiding">Hiding an option from <tt>--help</tt> output</a></li>
|
||||
<li><a href="#hiding">Hiding an option from <tt>-help</tt> output</a></li>
|
||||
<li><a href="#numoccurrences">Controlling the number of occurrences
|
||||
required and allowed</a></li>
|
||||
<li><a href="#valrequired">Controlling whether or not a value must be
|
||||
@ -1200,14 +1200,14 @@ usually shouldn't have to worry about these.</p>
|
||||
|
||||
<!-- _______________________________________________________________________ -->
|
||||
<div class="doc_subsubsection">
|
||||
<a name="hiding">Hiding an option from <tt>--help</tt> output</a>
|
||||
<a name="hiding">Hiding an option from <tt>-help</tt> output</a>
|
||||
</div>
|
||||
|
||||
<div class="doc_text">
|
||||
|
||||
<p>The <tt>cl::NotHidden</tt>, <tt>cl::Hidden</tt>, and
|
||||
<tt>cl::ReallyHidden</tt> modifiers are used to control whether or not an option
|
||||
appears in the <tt>--help</tt> and <tt>--help-hidden</tt> output for the
|
||||
appears in the <tt>-help</tt> and <tt>-help-hidden</tt> output for the
|
||||
compiled program:</p>
|
||||
|
||||
<ul>
|
||||
@ -1219,8 +1219,8 @@ in both help listings.</li>
|
||||
|
||||
<li><a name="cl::Hidden">The <b><tt>cl::Hidden</tt></b></a> modifier (which is the
|
||||
default for <tt><a href="#cl::alias">cl::alias</a></tt> options) indicates that
|
||||
the option should not appear in the <tt>--help</tt> output, but should appear in
|
||||
the <tt>--help-hidden</tt> output.</li>
|
||||
the option should not appear in the <tt>-help</tt> output, but should appear in
|
||||
the <tt>-help-hidden</tt> output.</li>
|
||||
|
||||
<li><a name="cl::ReallyHidden">The <b><tt>cl::ReallyHidden</tt></b></a> modifier
|
||||
indicates that the option should not appear in any help output.</li>
|
||||
@ -1508,7 +1508,7 @@ available.</p>
|
||||
<p>The <tt>cl::ParseCommandLineOptions</tt> function requires two parameters
|
||||
(<tt>argc</tt> and <tt>argv</tt>), but may also take an optional third parameter
|
||||
which holds <a href="#description">additional extra text</a> to emit when the
|
||||
<tt>--help</tt> option is invoked, and a fourth boolean parameter that enables
|
||||
<tt>-help</tt> option is invoked, and a fourth boolean parameter that enables
|
||||
<a href="#response">response files</a>.</p>
|
||||
|
||||
</div>
|
||||
@ -1535,7 +1535,7 @@ does.</p>
|
||||
not be available, it can't just look in <tt>argv[0]</tt>), the name of the
|
||||
environment variable to examine, the optional
|
||||
<a href="#description">additional extra text</a> to emit when the
|
||||
<tt>--help</tt> option is invoked, and the boolean
|
||||
<tt>-help</tt> option is invoked, and the boolean
|
||||
switch that controls whether <a href="#response">response files</a>
|
||||
should be read.</p>
|
||||
|
||||
@ -1689,7 +1689,7 @@ the conversion from string to data.</p>
|
||||
<div class="doc_text">
|
||||
|
||||
<p>The <tt>cl::extrahelp</tt> class is a nontemplated class that allows extra
|
||||
help text to be printed out for the <tt>--help</tt> option.</p>
|
||||
help text to be printed out for the <tt>-help</tt> option.</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
<b>namespace</b> cl {
|
||||
@ -1906,7 +1906,7 @@ MFS(<i>"max-file-size"</i>, <a href="#cl::desc">cl::desc</a>(<i>"Maximum file si
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
OPTIONS:
|
||||
-help - display available options (--help-hidden for more)
|
||||
-help - display available options (-help-hidden for more)
|
||||
...
|
||||
<b>-max-file-size=<size> - Maximum file size to accept</b>
|
||||
</pre></div>
|
||||
|
@ -132,7 +132,7 @@ directory with the compilation graph description in Graphviz format (identical
|
||||
to the file used by the <tt class="docutils literal"><span class="pre">--view-graph</span></tt> option). The <tt class="docutils literal"><span class="pre">-o</span></tt> option can be
|
||||
used to set the output file name. Hidden option, useful for debugging LLVMC
|
||||
plugins.</li>
|
||||
<li><tt class="docutils literal"><span class="pre">--help</span></tt>, <tt class="docutils literal"><span class="pre">--help-hidden</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt> - These options have
|
||||
<li><tt class="docutils literal"><span class="pre">-help</span></tt>, <tt class="docutils literal"><span class="pre">-help-hidden</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt> - These options have
|
||||
their standard meaning.</li>
|
||||
</ul>
|
||||
</div>
|
||||
@ -325,7 +325,7 @@ aliased option name. Usage example: <tt class="docutils literal"><span class="pr
|
||||
<li><p class="first">Possible option properties:</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal"><span class="pre">help</span></tt> - help string associated with this option. Used for <tt class="docutils literal"><span class="pre">--help</span></tt>
|
||||
<li><tt class="docutils literal"><span class="pre">help</span></tt> - help string associated with this option. Used for <tt class="docutils literal"><span class="pre">-help</span></tt>
|
||||
output.</li>
|
||||
<li><tt class="docutils literal"><span class="pre">required</span></tt> - this option must be specified exactly once (or, in case of
|
||||
the list options without the <tt class="docutils literal"><span class="pre">multi_val</span></tt> property, at least
|
||||
@ -338,7 +338,7 @@ it is synonymous with <tt class="docutils literal"><span class="pre">required</s
|
||||
for list options in conjunction with <tt class="docutils literal"><span class="pre">multi_val</span></tt>. Incompatible with
|
||||
<tt class="docutils literal"><span class="pre">required</span></tt> and <tt class="docutils literal"><span class="pre">one_or_more</span></tt>.</li>
|
||||
<li><tt class="docutils literal"><span class="pre">hidden</span></tt> - the description of this option will not appear in
|
||||
the <tt class="docutils literal"><span class="pre">--help</span></tt> output (but will appear in the <tt class="docutils literal"><span class="pre">--help-hidden</span></tt>
|
||||
the <tt class="docutils literal"><span class="pre">-help</span></tt> output (but will appear in the <tt class="docutils literal"><span class="pre">-help-hidden</span></tt>
|
||||
output).</li>
|
||||
<li><tt class="docutils literal"><span class="pre">really_hidden</span></tt> - the option will not be mentioned in any help
|
||||
output.</li>
|
||||
@ -748,7 +748,7 @@ the <tt class="docutils literal"><span class="pre">Base</span></tt> plugin behav
|
||||
<a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
|
||||
<a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
|
||||
|
||||
Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
|
||||
Last modified: $Date$
|
||||
</address></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -1369,7 +1369,7 @@ end to compile.</p>
|
||||
|
||||
<p>The <b>tools</b> directory contains the executables built out of the
|
||||
libraries above, which form the main part of the user interface. You can
|
||||
always get help for a tool by typing <tt>tool_name --help</tt>. The
|
||||
always get help for a tool by typing <tt>tool_name -help</tt>. The
|
||||
following is a brief introduction to the most important tools. More detailed
|
||||
information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
|
||||
|
||||
@ -1440,7 +1440,7 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
|
||||
<dt><tt><b>opt</b></tt></dt>
|
||||
<dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM
|
||||
transformations (which are specified on the command line), and then outputs
|
||||
the resultant bitcode. The '<tt>opt --help</tt>' command is a good way to
|
||||
the resultant bitcode. The '<tt>opt -help</tt>' command is a good way to
|
||||
get a list of the program transformations available in LLVM.<br>
|
||||
<dd><tt>opt</tt> can also be used to run a specific analysis on an input
|
||||
LLVM bitcode file and print out the results. It is primarily useful for
|
||||
|
@ -377,10 +377,10 @@ interesting way, we just throw away the result of <tt>opt</tt> (sending it to
|
||||
<tt>/dev/null</tt>).</p>
|
||||
|
||||
<p>To see what happened to the other string you registered, try running
|
||||
<tt>opt</tt> with the <tt>--help</tt> option:</p>
|
||||
<tt>opt</tt> with the <tt>-help</tt> option:</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
$ opt -load ../../../Debug/lib/Hello.so --help
|
||||
$ opt -load ../../../Debug/lib/Hello.so -help
|
||||
OVERVIEW: llvm .bc -> .bc modular optimizer
|
||||
|
||||
USAGE: opt [options] <input bitcode>
|
||||
@ -970,7 +970,7 @@ template, which requires you to pass at least two
|
||||
parameters. The first parameter is the name of the pass that is to be used on
|
||||
the command line to specify that the pass should be added to a program (for
|
||||
example, with <tt>opt</tt> or <tt>bugpoint</tt>). The second argument is the
|
||||
name of the pass, which is to be used for the <tt>--help</tt> output of
|
||||
name of the pass, which is to be used for the <tt>-help</tt> output of
|
||||
programs, as
|
||||
well as for debug output generated by the <tt>--debug-pass</tt> option.</p>
|
||||
|
||||
@ -1410,7 +1410,7 @@ allowing any analysis results to live across the execution of your pass.</p>
|
||||
options that is useful for debugging pass execution, seeing how things work, and
|
||||
diagnosing when you should be preserving more analyses than you currently are
|
||||
(To get information about all of the variants of the <tt>--debug-pass</tt>
|
||||
option, just type '<tt>opt --help-hidden</tt>').</p>
|
||||
option, just type '<tt>opt -help-hidden</tt>').</p>
|
||||
|
||||
<p>By using the <tt>--debug-pass=Structure</tt> option, for example, we can see
|
||||
how our <a href="#basiccode">Hello World</a> pass interacts with other passes.
|
||||
@ -1625,10 +1625,10 @@ form; </p>
|
||||
</pre></div>
|
||||
|
||||
<p>Note the two spaces prior to the help string produces a tidy result on the
|
||||
--help query.</p>
|
||||
-help query.</p>
|
||||
|
||||
<div class="doc_code"><pre>
|
||||
$ llc --help
|
||||
$ llc -help
|
||||
...
|
||||
-regalloc - Register allocator to use: (default = linearscan)
|
||||
=linearscan - linear scan register allocator
|
||||
|
@ -10,7 +10,7 @@
|
||||
// This tool provides a single point of access to the LLVM
|
||||
// compilation tools. It has many options. To discover the options
|
||||
// supported please refer to the tools' manual page or run the tool
|
||||
// with the --help option.
|
||||
// with the -help option.
|
||||
//
|
||||
// This file provides the default entry point for the driver executable.
|
||||
//
|
||||
|
@ -93,9 +93,9 @@ enum ValueExpected { // Is a value required for the option?
|
||||
};
|
||||
|
||||
enum OptionHidden { // Control whether -help shows this option
|
||||
NotHidden = 0x20, // Option included in --help & --help-hidden
|
||||
Hidden = 0x40, // -help doesn't, but --help-hidden does
|
||||
ReallyHidden = 0x60, // Neither --help nor --help-hidden show this arg
|
||||
NotHidden = 0x20, // Option included in -help & -help-hidden
|
||||
Hidden = 0x40, // -help doesn't, but -help-hidden does
|
||||
ReallyHidden = 0x60, // Neither -help nor -help-hidden show this arg
|
||||
HiddenMask = 0x60
|
||||
};
|
||||
|
||||
@ -159,7 +159,7 @@ class Option {
|
||||
Option *NextRegistered; // Singly linked list of registered options.
|
||||
public:
|
||||
const char *ArgStr; // The argument string itself (ex: "help", "o")
|
||||
const char *HelpStr; // The descriptive text message for --help
|
||||
const char *HelpStr; // The descriptive text message for -help
|
||||
const char *ValueStr; // String describing what the value of this option is
|
||||
|
||||
inline enum NumOccurrencesFlag getNumOccurrencesFlag() const {
|
||||
@ -251,14 +251,14 @@ public:
|
||||
// command line option parsers...
|
||||
//
|
||||
|
||||
// desc - Modifier to set the description shown in the --help output...
|
||||
// desc - Modifier to set the description shown in the -help output...
|
||||
struct desc {
|
||||
const char *Desc;
|
||||
desc(const char *Str) : Desc(Str) {}
|
||||
void apply(Option &O) const { O.setDescription(Desc); }
|
||||
};
|
||||
|
||||
// value_desc - Modifier to set the value description shown in the --help
|
||||
// value_desc - Modifier to set the value description shown in the -help
|
||||
// output...
|
||||
struct value_desc {
|
||||
const char *Desc;
|
||||
@ -437,7 +437,7 @@ protected:
|
||||
// Default parser implementation - This implementation depends on having a
|
||||
// mapping of recognized options to values of some sort. In addition to this,
|
||||
// each entry in the mapping also tracks a help message that is printed with the
|
||||
// command line option for --help. Because this is a simple mapping parser, the
|
||||
// command line option for -help. Because this is a simple mapping parser, the
|
||||
// data type can be any unsupported type.
|
||||
//
|
||||
template <class DataType>
|
||||
@ -1373,7 +1373,7 @@ struct extrahelp {
|
||||
|
||||
void PrintVersionMessage();
|
||||
// This function just prints the help message, exactly the same way as if the
|
||||
// --help option had been given on the command line.
|
||||
// -help option had been given on the command line.
|
||||
// NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
|
||||
void PrintHelpMessage();
|
||||
|
||||
|
@ -650,7 +650,7 @@ void cl::ParseCommandLineOptions(int argc, char **argv,
|
||||
if (Handler == 0) {
|
||||
if (SinkOpts.empty()) {
|
||||
errs() << ProgramName << ": Unknown command line argument '"
|
||||
<< argv[i] << "'. Try: '" << argv[0] << " --help'\n";
|
||||
<< argv[i] << "'. Try: '" << argv[0] << " -help'\n";
|
||||
ErrorParsing = true;
|
||||
} else {
|
||||
for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
|
||||
@ -673,7 +673,7 @@ void cl::ParseCommandLineOptions(int argc, char **argv,
|
||||
errs() << ProgramName
|
||||
<< ": Not enough positional command line arguments specified!\n"
|
||||
<< "Must specify at least " << NumPositionalRequired
|
||||
<< " positional arguments: See: " << argv[0] << " --help\n";
|
||||
<< " positional arguments: See: " << argv[0] << " -help\n";
|
||||
|
||||
ErrorParsing = true;
|
||||
} else if (!HasUnlimitedPositionals
|
||||
@ -681,7 +681,7 @@ void cl::ParseCommandLineOptions(int argc, char **argv,
|
||||
errs() << ProgramName
|
||||
<< ": Too many positional arguments specified!\n"
|
||||
<< "Can specify at most " << PositionalOpts.size()
|
||||
<< " positional arguments: See: " << argv[0] << " --help\n";
|
||||
<< " positional arguments: See: " << argv[0] << " -help\n";
|
||||
ErrorParsing = true;
|
||||
|
||||
} else if (ConsumeAfterOpt == 0) {
|
||||
@ -1029,7 +1029,7 @@ void generic_parser_base::printOptionInfo(const Option &O,
|
||||
|
||||
|
||||
//===----------------------------------------------------------------------===//
|
||||
// --help and --help-hidden option implementation
|
||||
// -help and -help-hidden option implementation
|
||||
//
|
||||
|
||||
static int OptNameCompare(const void *LHS, const void *RHS) {
|
||||
@ -1134,7 +1134,7 @@ static HelpPrinter NormalPrinter(false);
|
||||
static HelpPrinter HiddenPrinter(true);
|
||||
|
||||
static cl::opt<HelpPrinter, true, parser<bool> >
|
||||
HOp("help", cl::desc("Display available options (--help-hidden for more)"),
|
||||
HOp("help", cl::desc("Display available options (-help-hidden for more)"),
|
||||
cl::location(NormalPrinter), cl::ValueDisallowed);
|
||||
|
||||
static cl::opt<HelpPrinter, true, parser<bool> >
|
||||
@ -1222,8 +1222,8 @@ void cl::PrintHelpMessage() {
|
||||
// NormalPrinter variable is a HelpPrinter and the help gets printed when
|
||||
// its operator= is invoked. That's because the "normal" usages of the
|
||||
// help printer is to be assigned true/false depending on whether the
|
||||
// --help option was given or not. Since we're circumventing that we have
|
||||
// to make it look like --help was given, so we assign true.
|
||||
// -help option was given or not. Since we're circumventing that we have
|
||||
// to make it look like -help was given, so we assign true.
|
||||
NormalPrinter = true;
|
||||
}
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user