Add a 'Debugging' section to the documentation.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@56464 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Mikhail Glushenkov 2008-09-22 20:48:48 +00:00
parent 0737651452
commit 9ecd30c4a2

View File

@ -69,7 +69,7 @@ configuration files:
* ``-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 @@ located in the file ``Tools.td`` and looks like this::
...
]>;
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/