summaryrefslogtreecommitdiffstats
path: root/llvm/docs
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2009-01-09 16:16:27 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2009-01-09 16:16:27 +0000
commit0f88cfa2ac4b20c79f398b08da0945d1a4d8fe03 (patch)
tree8f5e3833cacba2d4ed18a05660284b90cad23599 /llvm/docs
parentb3a8798253f8e4845034c237d45c33e926d55ae8 (diff)
downloadbcm5719-llvm-0f88cfa2ac4b20c79f398b08da0945d1a4d8fe03.tar.gz
bcm5719-llvm-0f88cfa2ac4b20c79f398b08da0945d1a4d8fe03.zip
Add a --check-graph option to llvmc.
llvm-svn: 61989
Diffstat (limited to 'llvm/docs')
-rw-r--r--llvm/docs/CommandGuide/llvmc.pod6
-rw-r--r--llvm/docs/CompilerDriver.html10
2 files changed, 16 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvmc.pod b/llvm/docs/CommandGuide/llvmc.pod
index 7bfc3d71cba..17d85d73890 100644
--- a/llvm/docs/CommandGuide/llvmc.pod
+++ b/llvm/docs/CommandGuide/llvmc.pod
@@ -42,6 +42,12 @@ S<-load $LLVM_DIR/Release/lib/LLVMCSimple.so>.
Enable verbose mode, i.e. print out all executed commands.
+=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.
+
=item B<--view-graph>
Show a graphical representation of the compilation graph. Requires
diff --git a/llvm/docs/CompilerDriver.html b/llvm/docs/CompilerDriver.html
index 7d0399016d0..e49b2e98ae2 100644
--- a/llvm/docs/CompilerDriver.html
+++ b/llvm/docs/CompilerDriver.html
@@ -107,6 +107,9 @@ 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:
<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>
@@ -566,6 +569,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>
<hr />
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer">
OpenPOWER on IntegriCloud