summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlp Toker <alp@nuanti.com>2014-06-02 01:40:04 +0000
committerAlp Toker <alp@nuanti.com>2014-06-02 01:40:04 +0000
commit04de60e28f29613ea762fc7221197f7a2c4ade80 (patch)
treee081176c7664085c662678a3c48912cd7ba739a2 /docs
parentdf1913982b1d09b6cf01bc10f8ca97f50bb22a1b (diff)
downloadllvm-04de60e28f29613ea762fc7221197f7a2c4ade80.tar.gz
llvm-04de60e28f29613ea762fc7221197f7a2c4ade80.tar.bz2
llvm-04de60e28f29613ea762fc7221197f7a2c4ade80.tar.xz
GraphWriter: detect graph viewer programs at runtime
Replace the crufty build-time configure checks for program paths with equivalent runtime logic. This lets users install graphing tools as needed without having to reconfigure and rebuild LLVM, while eliminating a long chain of inappropriate compile dependencies that included GUI programs and the windowing system. Additional features: * Support the OS X 'open' command to view graphs generated by any of the Graphviz utilities. This is an alternative to the Graphviz OS X UI which is no longer available on Mountain Lion. * Produce informative log output upon failure to indicate which programs can be installed to view graphs. Ping me if this doesn't work for your particular environment. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@210001 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/ProgrammersManual.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst
index 7e46ac4e8e..8d9668e4ee 100644
--- a/docs/ProgrammersManual.rst
+++ b/docs/ProgrammersManual.rst
@@ -545,14 +545,15 @@ methods. Within GDB, for example, you can usually use something like ``call
DAG.viewGraph()`` to pop up a window. Alternatively, you can sprinkle calls to
these functions in your code in places you want to debug.
-Getting this to work requires a small amount of configuration. On Unix systems
+Getting this to work requires a small amount of setup. On Unix systems
with X11, install the `graphviz <http://www.graphviz.org>`_ toolkit, and make
sure 'dot' and 'gv' are in your path. If you are running on Mac OS X, download
and install the Mac OS X `Graphviz program
<http://www.pixelglow.com/graphviz/>`_ and add
``/Applications/Graphviz.app/Contents/MacOS/`` (or wherever you install it) to
-your path. Once in your system and path are set up, rerun the LLVM configure
-script and rebuild LLVM to enable this functionality.
+your path. The programs need not be present when configuring, building or
+running LLVM and can simply be installed when needed during an active debug
+session.
``SelectionDAG`` has been extended to make it easier to locate *interesting*
nodes in large complex graphs. From gdb, if you ``call DAG.setGraphColor(node,