From 0f88cfa2ac4b20c79f398b08da0945d1a4d8fe03 Mon Sep 17 00:00:00 2001
From: Mikhail Glushenkov 
Date: Fri, 9 Jan 2009 16:16:27 +0000
Subject: Add a --check-graph option to llvmc.
llvm-svn: 61989
---
 llvm/docs/CommandGuide/llvmc.pod |  6 ++++++
 llvm/docs/CompilerDriver.html    | 10 ++++++++++
 2 files changed, 16 insertions(+)
(limited to 'llvm/docs')
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.
 -load PLUGIN_NAME - Load the specified plugin DLL. Example:
 -load $LLVM_DIR/Release/lib/LLVMCSimple.so.
 -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.
@@ -566,6 +569,13 @@ line option --view-graph
 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.
 
 
 
-- 
cgit v1.2.3