[llvm-commits] [llvm] r67836 - in /llvm/trunk: docs/CommandGuide/llvmc.pod docs/CompilerDriver.html tools/llvmc/doc/LLVMC-Reference.rst

Fri Mar 27 05:58:30 PDT 2009

Author: foldr
Date: Fri Mar 27 07:58:29 2009
New Revision: 67836

URL: http://llvm.org/viewvc/llvm-project?rev=67836&view=rev
Log:
Documentation update.

Expand a bit on various '--*-graph' options.

Modified:
    llvm/trunk/docs/CommandGuide/llvmc.pod
    llvm/trunk/docs/CompilerDriver.html
    llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst

Modified: llvm/trunk/docs/CommandGuide/llvmc.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvmc.pod?rev=67836&r1=67835&r2=67836&view=diff

==============================================================================

--- llvm/trunk/docs/CommandGuide/llvmc.pod (original)
+++ llvm/trunk/docs/CommandGuide/llvmc.pod Fri Mar 27 07:58:29 2009
@@ -44,21 +44,24 @@
 
 =item B<--check-graph>
 
-Check the compilation for common errors like mismatched output/input
-language names, multiple default edges and cycles. Hidden option,
-useful for debugging.
+Check the compilation for common errors like mismatched output/input language
+names, multiple default edges and cycles. Because of plugins, these checks can't
+be performed at compile-time. Exit with code zero if no errors were found, and
+return the number of found errors otherwise. Hidden option, useful for debugging
+LLVMC plugins.
 
 =item B<--view-graph>
 
-Show a graphical representation of the compilation graph. Requires
-that you have I<dot> and I<gv> programs installed. Hidden option,
-useful for debugging.
+Show a graphical representation of the compilation graph and exit. Requires that
+you have I<dot> and I<gv> programs installed. Hidden option, useful for
+debugging LLVMC plugins.
 
 =item B<--write-graph>
 
-Write a I<compilation-graph.dot> file in the current directory with
-the compilation graph description in the Graphviz format. Hidden
-option, useful for debugging.
+Write a I<compilation-graph.dot> file in the current directory with the
+compilation graph description in Graphviz format (identical to the file used by
+the B<--view-graph> option). The B<-o> option can be used to set the output file
+name. Hidden option, useful for debugging LLVMC plugins.
 
 =item B<--save-temps>
 
@@ -109,7 +112,8 @@
 
 =item B<-opt>
 
-Enable optimization with B<opt>.
+Enable optimization passes with B<opt>. To pass options to the B<opt> program
+use the B<-Wo,> option.
 
 =item B<-I> I<directory>
 

Modified: llvm/trunk/docs/CompilerDriver.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CompilerDriver.html?rev=67836&r1=67835&r2=67836&view=diff

==============================================================================
--- llvm/trunk/docs/CompilerDriver.html (original)
+++ llvm/trunk/docs/CompilerDriver.html Fri Mar 27 07:58:29 2009
@@ -107,15 +107,18 @@
 <li><tt class="docutils literal"><span class="pre">-load</span> <span class="pre">PLUGIN_NAME</span></tt> - Load the specified plugin DLL. Example:
 <tt class="docutils literal"><span class="pre">-load</span> <span class="pre">$LLVM_DIR/Release/lib/LLVMCSimple.so</span></tt>.</li>
 <li><tt class="docutils literal"><span class="pre">-v</span></tt> - Enable verbose mode, i.e. print out all executed commands.</li>
-<li><tt class="docutils literal"><span class="pre">--check-graph</span></tt> - Check the compilation for common errors like
-mismatched output/input language names, multiple default edges and
-cycles. Hidden option, useful for debugging.</li>
-<li><tt class="docutils literal"><span class="pre">--view-graph</span></tt> - Show a graphical representation of the compilation
-graph. Requires that you have <tt class="docutils literal"><span class="pre">dot</span></tt> and <tt class="docutils literal"><span class="pre">gv</span></tt> programs
-installed. Hidden option, useful for debugging.</li>
-<li><tt class="docutils literal"><span class="pre">--write-graph</span></tt> - Write a <tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt> file in the
-current directory with the compilation graph description in the
-Graphviz format. Hidden option, useful for debugging.</li>
+<li><tt class="docutils literal"><span class="pre">--check-graph</span></tt> - Check the compilation for common errors like mismatched
+output/input language names, multiple default edges and cycles. Because of
+plugins, these checks can't be performed at compile-time. Exit with code zero if
+no errors were found, and return the number of found errors otherwise. Hidden
+option, useful for debugging LLVMC plugins.</li>
+<li><tt class="docutils literal"><span class="pre">--view-graph</span></tt> - Show a graphical representation of the compilation graph
+and exit. Requires that you have <tt class="docutils literal"><span class="pre">dot</span></tt> and <tt class="docutils literal"><span class="pre">gv</span></tt> programs installed. Hidden
+option, useful for debugging LLVMC plugins.</li>
+<li><tt class="docutils literal"><span class="pre">--write-graph</span></tt> - Write a <tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt> file in the current
+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">--save-temps</span></tt> - Write temporary files to the current directory
 and do not delete them on exit. Hidden option, useful for debugging.</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
@@ -589,7 +592,7 @@
 <p>When writing LLVMC plugins, it can be useful to get a visual view of
 the resulting compilation graph. This can be achieved via the command
 line option <tt class="docutils literal"><span class="pre">--view-graph</span></tt>. This command assumes that <a class="reference" href="http://www.graphviz.org/">Graphviz</a> and
-<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
+<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">--write-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 <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
@@ -611,7 +614,7 @@
 <a href="mailto:foldr at codedgers.com">Mikhail Glushenkov</a><br />
 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br />
 
-Last modified: $Date$
+Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $
 </address></div>
 </div>
 </div>

Modified: llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst?rev=67836&r1=67835&r2=67836&view=diff

==============================================================================
--- llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst (original)
+++ llvm/trunk/tools/llvmc/doc/LLVMC-Reference.rst Fri Mar 27 07:58:29 2009
@@ -92,17 +92,20 @@
 
 * ``-v`` - Enable verbose mode, i.e. print out all executed commands.
 
-* ``--check-graph`` - Check the compilation for common errors like
-  mismatched output/input language names, multiple default edges and
-  cycles. Hidden option, useful for debugging.
-
-* ``--view-graph`` - Show a graphical representation of the compilation
-  graph. Requires that you have ``dot`` and ``gv`` programs
-  installed. Hidden option, useful for debugging.
-
-* ``--write-graph`` - Write a ``compilation-graph.dot`` file in the
-  current directory with the compilation graph description in the
-  Graphviz format. Hidden option, useful for debugging.
+* ``--check-graph`` - Check the compilation for common errors like mismatched
+  output/input language names, multiple default edges and cycles. Because of
+  plugins, these checks can't be performed at compile-time. Exit with code zero if
+  no errors were found, and return the number of found errors otherwise. Hidden
+  option, useful for debugging LLVMC plugins.
+
+* ``--view-graph`` - Show a graphical representation of the compilation graph
+  and exit. Requires that you have ``dot`` and ``gv`` programs installed. Hidden
+  option, useful for debugging LLVMC plugins.
+
+* ``--write-graph`` - Write a ``compilation-graph.dot`` file in the current
+  directory with the compilation graph description in Graphviz format (identical
+  to the file used by the ``--view-graph`` option). The ``-o`` option can be used
+  to set the output file name. Hidden option, useful for debugging LLVMC plugins.
 
 * ``--save-temps`` - Write temporary files to the current directory
   and do not delete them on exit. Hidden option, useful for debugging.
@@ -631,7 +634,7 @@
 When writing LLVMC plugins, it can be useful to get a visual view of
 the resulting compilation graph. This can be achieved via the command
 line option ``--view-graph``. This command assumes that Graphviz_ and
-Ghostview_ are installed. There is also a ``--dump-graph`` option that
+Ghostview_ are installed. There is also a ``--write-graph`` option that
 creates a Graphviz source file (``compilation-graph.dot``) in the
 current directory.
 



