summaryrefslogtreecommitdiffstats
path: root/Modules/CMakeGraphVizOptions.cmake
diff options
context:
space:
mode:
authorHarry Mallon <harry@codexdigital.com>2016-11-23 12:04:33 (GMT)
committerBrad King <brad.king@kitware.com>2016-11-29 15:05:02 (GMT)
commitf7c2a803a80d41de41f6b4838d49be2f8bae4afc (patch)
tree479b7a92cc190eafc8b47008b80f8276620128f7 /Modules/CMakeGraphVizOptions.cmake
parent1b22cb0a07be25bf6b8bf3afc8ffae7c928a90c9 (diff)
downloadCMake-f7c2a803a80d41de41f6b4838d49be2f8bae4afc.zip
CMake-f7c2a803a80d41de41f6b4838d49be2f8bae4afc.tar.gz
CMake-f7c2a803a80d41de41f6b4838d49be2f8bae4afc.tar.bz2
CMakeGraphVizOptions: Minor improvements to docs.
* Add `GRAPHVIZ_GRAPH_TYPE` options. * Correct inaccurate usage info.
Diffstat (limited to 'Modules/CMakeGraphVizOptions.cmake')
-rw-r--r--Modules/CMakeGraphVizOptions.cmake13
1 files changed, 10 insertions, 3 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake
index e7c4de6..420e3a9 100644
--- a/Modules/CMakeGraphVizOptions.cmake
+++ b/Modules/CMakeGraphVizOptions.cmake
@@ -13,8 +13,8 @@
# CMake
# can generate graphviz files, showing the dependencies between the
# targets in a project and also external libraries which are linked
-# against. When CMake is run with the --graphviz=foo option, it will
-# produce
+# against. When CMake is run with the --graphviz=foo.dot option, it will
+# produce:
#
# * a foo.dot file showing all dependencies in the project
# * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
@@ -29,11 +29,18 @@
#
# .. variable:: GRAPHVIZ_GRAPH_TYPE
#
-# The graph type
+# The graph type.
#
# * Mandatory : NO
# * Default : "digraph"
#
+# Valid graph types are:
+#
+# * "graph" : Nodes are joined with lines
+# * "digraph" : Nodes are joined with arrows showing direction
+# * "strict graph" : Like "graph" but max one line between each node
+# * "strict digraph" : Like "graph" but max one line between each node in each direction
+#
# .. variable:: GRAPHVIZ_GRAPH_NAME
#
# The graph name.