summaryrefslogtreecommitdiff
path: root/Modules/CMakeGraphVizOptions.cmake
diff options
context:
space:
mode:
authorJano Svitok <jan.svitok@gmail.com>2017-09-05 18:34:44 +0200
committerJano Svitok <jsv@whitestein.com>2017-09-11 14:45:36 +0200
commit7ed35aa331b58fce396e68d756f139b098acbac0 (patch)
treee81e2d1b6e41ca38333cea833e0987894066c3a4 /Modules/CMakeGraphVizOptions.cmake
parent8362db82ec442195bf361898655a683548a2f023 (diff)
downloadcmake-7ed35aa331b58fce396e68d756f139b098acbac0.tar.gz
Docs: Improve markup for graphviz related documentation
- add hyperlink to CMakeGraphVizOptions.cmake in cmake(1) - improve markup in CMakeGraphVizOptions.cmake
Diffstat (limited to 'Modules/CMakeGraphVizOptions.cmake')
-rw-r--r--Modules/CMakeGraphVizOptions.cmake14
1 files changed, 7 insertions, 7 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake
index 420e3a9e7b..3976581010 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.
#