Some small documentation fixes.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@62251 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/CompilerDriver.html b/docs/CompilerDriver.html
index fcd66bab3ab65e75232e8449565c1c2cf7a822b5..977bd470c68241d46d773f9e8626a2dc6fd429b2 100644 (file)
--- 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">

diff --git a/tools/llvmc/doc/LLVMC-Reference.rst b/tools/llvmc/doc/LLVMC-Reference.rst
index e28def74d5eaa9fca2c48cd439fd6067ae89b03d..d70b4a55988c45eb4bc1bd4487b13990953d1c60 100644 (file)
--- a/tools/llvmc/doc/LLVMC-Reference.rst
+++ b/tools/llvmc/doc/LLVMC-Reference.rst
@@ -294,10 +294,11 @@ separate option groups syntactically.
 
    - ``required`` - this option is obligatory.
 
-   - ``hidden`` - this option should not appear in the ``--help``
-     output (but should appear in the ``--help-hidden`` output).
+   - ``hidden`` - the description of this option will not appear in
+     the ``--help`` output (but will appear in the ``--help-hidden``
+     output).
 
-   - ``really_hidden`` - the option should not appear in any help
+   - ``really_hidden`` - the option will not be mentioned in any help
      output.
 
    - ``extern`` - this option is defined in some other plugin, see below.
@@ -307,7 +308,7 @@ External options
 
 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
 ``extern``. This is what the ``extern`` option property is
 for. Example::
 
@@ -614,13 +615,13 @@ Ghostview_ are installed. There is also a ``--dump-graph`` option that
 creates a Graphviz source file (``compilation-graph.dot``) in the
 current directory.
 
-Another useful option is ``--check-graph``. 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 ``--check-graph``, ``llvmc`` doesn't perform any
-compilation tasks and returns the number of encountered errors as its
-status code.
+Another useful ``llvmc`` option is ``--check-graph``. 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 ``--check-graph``, ``llvmc`` doesn't
+perform any compilation tasks and returns the number of encountered
+errors as its status code.
 
 .. _Graphviz: http://www.graphviz.org/
 .. _Ghostview: http://pages.cs.wisc.edu/~ghost/