summaryrefslogtreecommitdiff
path: root/docs/WritingAnLLVMPass.html
diff options
context:
space:
mode:
authorDuncan Sands <baldrick@free.fr>2010-02-18 14:08:13 +0000
committerDuncan Sands <baldrick@free.fr>2010-02-18 14:08:13 +0000
commit7e7ae5ad692760aa8d97477f061a05b10948cf57 (patch)
treeb1825df8e9523cdebe7f898b38e97d2e12aff7e0 /docs/WritingAnLLVMPass.html
parent3460f221cd9d3329aefb3f10a0f9d0800d8db70a (diff)
downloadllvm-7e7ae5ad692760aa8d97477f061a05b10948cf57.tar.gz
llvm-7e7ae5ad692760aa8d97477f061a05b10948cf57.tar.bz2
llvm-7e7ae5ad692760aa8d97477f061a05b10948cf57.tar.xz
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
Diffstat (limited to 'docs/WritingAnLLVMPass.html')
-rw-r--r--docs/WritingAnLLVMPass.html12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html
index f531a74a68..83de4f9b9d 100644
--- a/docs/WritingAnLLVMPass.html
+++ b/docs/WritingAnLLVMPass.html
@@ -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 -&gt; .bc modular optimizer
USAGE: opt [options] &lt;input bitcode&gt;
@@ -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