RPCS3/llvm
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm.git synced 2025-04-03 13:51:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@67836 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Mikhail Glushenkov 2009-03-27 12:58:29 +00:00
parent d50d32b940
commit 4ad0d571fa
3 changed files with 41 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/CommandGuide/llvmc.pod
View File

@ -44,21 +44,24 @@ Enable verbose mode, i.e. print out all executed commands.
=item B<--check-graph> =item B<--check-graph>
Check the compilation for common errors like mismatched output/input Check the compilation for common errors like mismatched output/input language
language names, multiple default edges and cycles. Hidden option, names, multiple default edges and cycles. Because of plugins, these checks can't
useful for debugging. 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> =item B<--view-graph>
Show a graphical representation of the compilation graph. Requires Show a graphical representation of the compilation graph and exit. Requires that
that you have I<dot> and I<gv> programs installed. Hidden option, you have I<dot> and I<gv> programs installed. Hidden option, useful for
useful for debugging. debugging LLVMC plugins.
=item B<--write-graph> =item B<--write-graph>
Write a I<compilation-graph.dot> file in the current directory with Write a I<compilation-graph.dot> file in the current directory with the
the compilation graph description in the Graphviz format. Hidden compilation graph description in Graphviz format (identical to the file used by
option, useful for debugging. 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> =item B<--save-temps>
@ -109,7 +112,8 @@ Use Clang instead of llvm-gcc.
=item B<-opt> =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> =item B<-I> I<directory>

25
docs/CompilerDriver.html
View File

@ -107,15 +107,18 @@ until the next -x option.</li>
<li><tt class="docutils literal"><span class="pre">-load</span> <span class="pre">PLUGIN_NAME</span></tt> - Load the specified plugin DLL. Example: <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> <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">-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 <li><tt class="docutils literal"><span class="pre">--check-graph</span></tt> - Check the compilation for common errors like mismatched
mismatched output/input language names, multiple default edges and output/input language names, multiple default edges and cycles. Because of
cycles. Hidden option, useful for debugging.</li> plugins, these checks can't be performed at compile-time. Exit with code zero if
<li><tt class="docutils literal"><span class="pre">--view-graph</span></tt> - Show a graphical representation of the compilation no errors were found, and return the number of found errors otherwise. Hidden
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 option, useful for debugging LLVMC plugins.</li>
installed. 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
<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 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
current directory with the compilation graph description in the option, useful for debugging LLVMC plugins.</li>
Graphviz format. 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 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 <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> 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 <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 @@ loaded last.</p>
<p>When writing LLVMC plugins, it can be useful to get a visual view of <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 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 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 creates a Graphviz source file (<tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt>) in the
current directory.</p> 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 <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 @@ errors as its status code.</p>
<a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br /> <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br />
<a href="http://llvm.org">LLVM Compiler Infrastructure</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> </address></div>
</div> </div>
</div> </div>

23
tools/llvmc/doc/LLVMC-Reference.rst
View File

@ -92,17 +92,20 @@ configuration libraries:
* ``-v`` - Enable verbose mode, i.e. print out all executed commands. * ``-v`` - Enable verbose mode, i.e. print out all executed commands.
* ``--check-graph`` - Check the compilation for common errors like * ``--check-graph`` - Check the compilation for common errors like mismatched
mismatched output/input language names, multiple default edges and output/input language names, multiple default edges and cycles. Because of
cycles. Hidden option, useful for debugging. 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 * ``--view-graph`` - Show a graphical representation of the compilation graph
graph. Requires that you have ``dot`` and ``gv`` programs and exit. Requires that you have ``dot`` and ``gv`` programs installed. Hidden
installed. Hidden option, useful for debugging. option, useful for debugging LLVMC plugins.
* ``--write-graph`` - Write a ``compilation-graph.dot`` file in the * ``--write-graph`` - Write a ``compilation-graph.dot`` file in the current
current directory with the compilation graph description in the directory with the compilation graph description in Graphviz format (identical
Graphviz format. Hidden option, useful for debugging. 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 * ``--save-temps`` - Write temporary files to the current directory
and do not delete them on exit. Hidden option, useful for debugging. and do not delete them on exit. Hidden option, useful for debugging.
@ -631,7 +634,7 @@ Debugging
When writing LLVMC plugins, it can be useful to get a visual view of 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 the resulting compilation graph. This can be achieved via the command
line option ``--view-graph``. This command assumes that Graphviz_ and 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 creates a Graphviz source file (``compilation-graph.dot``) in the
current directory. current directory.