aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CompilerDriver.html
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2009-01-15 02:42:40 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2009-01-15 02:42:40 +0000
commitf9b1d79a549269f0630edd4893c654953ae07a6a (patch)
treefc1bc68f4c5d61068436e688d6053c073109541a /docs/CompilerDriver.html
parent564b75a4c6964768b537c737bb5c6e947032f309 (diff)
downloadexternal_llvm-f9b1d79a549269f0630edd4893c654953ae07a6a.zip
external_llvm-f9b1d79a549269f0630edd4893c654953ae07a6a.tar.gz
external_llvm-f9b1d79a549269f0630edd4893c654953ae07a6a.tar.bz2
Some small documentation fixes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@62251 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CompilerDriver.html')
-rw-r--r--docs/CompilerDriver.html23
1 files changed, 12 insertions, 11 deletions
diff --git a/docs/CompilerDriver.html b/docs/CompilerDriver.html
index fcd66ba..977bd47 100644
--- a/docs/CompilerDriver.html
+++ b/docs/CompilerDriver.html
@@ -290,9 +290,10 @@ example: <tt class="docutils literal"><span class="pre">(alias_option</span> <sp
<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 is obligatory.</li>
-<li><tt class="docutils literal"><span class="pre">hidden</span></tt> - this option should not appear in the <tt class="docutils literal"><span class="pre">--help</span></tt>
-output (but should 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 should not appear in any help
+<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>
+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>
<li><tt class="docutils literal"><span class="pre">extern</span></tt> - this option is defined in some other plugin, see below.</li>
</ul>
@@ -303,7 +304,7 @@ output.</li>
<h2><a class="toc-backref" href="#id10" id="external-options" name="external-options">External options</a></h2>
<p>Sometimes, when linking several plugins together, one plugin needs to
access options defined in some other plugin. Because of the way
-options are implemented, such options should be marked as
+options are implemented, such options must be marked as
<tt class="docutils literal"><span class="pre">extern</span></tt>. This is what the <tt class="docutils literal"><span class="pre">extern</span></tt> option property is
for. Example:</p>
<pre class="literal-block">
@@ -574,13 +575,13 @@ line option <tt class="docutils literal"><span class="pre">--view-graph</span></
<a class="reference" href="http://pages.cs.wisc.edu/~ghost/">Ghostview</a> are installed. There is also a <tt class="docutils literal"><span class="pre">--dump-graph</span></tt> option that
creates a Graphviz source file (<tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt>) in the
current directory.</p>
-<p>Another useful option is <tt class="docutils literal"><span class="pre">--check-graph</span></tt>. It checks the compilation
-graph for common errors like mismatched output/input language names,
-multiple default edges and cycles. These checks can't be performed at
-compile-time because the plugins can load code dynamically. When
-invoked with <tt class="docutils literal"><span class="pre">--check-graph</span></tt>, <tt class="docutils literal"><span class="pre">llvmc</span></tt> doesn't perform any
-compilation tasks and returns the number of encountered errors as its
-status code.</p>
+<p>Another useful <tt class="docutils literal"><span class="pre">llvmc</span></tt> option is <tt class="docutils literal"><span class="pre">--check-graph</span></tt>. It checks the
+compilation graph for common errors like mismatched output/input
+language names, multiple default edges and cycles. These checks can't
+be performed at compile-time because the plugins can load code
+dynamically. When invoked with <tt class="docutils literal"><span class="pre">--check-graph</span></tt>, <tt class="docutils literal"><span class="pre">llvmc</span></tt> doesn't
+perform any compilation tasks and returns the number of encountered
+errors as its status code.</p>
<hr />
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer">