summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2017-09-14 00:38:34 (GMT)
committerKitware Robot <kwrobot@kitware.com>2017-09-14 00:38:40 (GMT)
commitdd67b65188a03be8b1c961d5cd932f654e2566ae (patch)
tree5989f203abffdbe37dd72afa66f248f70b5d58a8 /Modules
parent420874bfaa20772525c60b20d1ee5b6ef5ed9298 (diff)
parent7ed35aa331b58fce396e68d756f139b098acbac0 (diff)
downloadCMake-dd67b65188a03be8b1c961d5cd932f654e2566ae.zip
CMake-dd67b65188a03be8b1c961d5cd932f654e2566ae.tar.gz
CMake-dd67b65188a03be8b1c961d5cd932f654e2566ae.tar.bz2
Merge topic 'improve-graphviz-doc'
7ed35aa3 Docs: Improve markup for graphviz related documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1236
Diffstat (limited to 'Modules')
-rw-r--r--Modules/CMakeGraphVizOptions.cmake14
1 files changed, 7 insertions, 7 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake
index 420e3a9..3976581 100644
--- a/Modules/CMakeGraphVizOptions.cmake
+++ b/Modules/CMakeGraphVizOptions.cmake
@@ -11,19 +11,19 @@
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# CMake
-# can generate graphviz files, showing the dependencies between the
+# can generate `graphviz <http://www.graphviz.org/>`_ 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.dot option, it will
+# 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
-# * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
+# * 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
+# * a ``foo.dot.<target>.dependers`` file, showing which other targets depend on the respective target
#
# This can result in huge graphs. Using the file
-# CMakeGraphVizOptions.cmake the look and content of the generated
+# ``CMakeGraphVizOptions.cmake`` the look and content of the generated
# graphs can be influenced. This file is searched first in
-# ${CMAKE_BINARY_DIR} and then in ${CMAKE_SOURCE_DIR}. If found, it is
+# :variable:`CMAKE_BINARY_DIR` and then in :variable:`CMAKE_SOURCE_DIR`. If found, it is
# read and the variables set in it are used to adjust options for the
# generated graphviz files.
#