[llvm-commits] [llvm] r56464 - /llvm/trunk/tools/llvmc2/doc/LLVMC-Reference.rst

[Mikhail Glushenkov]

Author: foldr
Date: Mon Sep 22 15:48:48 2008
New Revision: 56464

URL: http://llvm.org/viewvc/llvm-project?rev=56464&view=rev
Log:
Add a 'Debugging' section to the documentation.

Modified:
    llvm/trunk/tools/llvmc2/doc/LLVMC-Reference.rst

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

==============================================================================
--- llvm/trunk/tools/llvmc2/doc/LLVMC-Reference.rst (original)
+++ llvm/trunk/tools/llvmc2/doc/LLVMC-Reference.rst Mon Sep 22 15:48:48 2008
@@ -69,7 +69,7 @@
 * ``-v`` - Enable verbose mode, i.e. print out all executed commands.
 
 * ``--view-graph`` - Show a graphical representation of the compilation
-  graph. Requires that you have ``dot`` and ``gv`` commands
+  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
@@ -414,9 +414,25 @@
          ...
         ]>;
 
+Debugging
+=========
+
+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 [2]_ and
+Ghostview [3]_ are installed. There is also a ``--dump-graph`` option that
+creates a Graphviz source file(``compilation-graph.dot``) in the
+current directory.
+
 
 References
 ==========
 
 .. [1] TableGen Fundamentals
        http://llvm.cs.uiuc.edu/docs/TableGenFundamentals.html
+
+.. [2] Graphviz
+       http://www.graphviz.org/
+
+.. [3] Ghostview
+       http://pages.cs.wisc.edu/~ghost/