Browse Source

Docs: Improve markup for graphviz related documentation

- add hyperlink to CMakeGraphVizOptions.cmake in cmake(1)
- improve markup in CMakeGraphVizOptions.cmake
Jano Svitok 8 years ago
parent
commit
7ed35aa331
2 changed files with 9 additions and 9 deletions
  1. 2 2
      Help/manual/cmake.1.rst
  2. 7 7
      Modules/CMakeGraphVizOptions.cmake

+ 2 - 2
Help/manual/cmake.1.rst

@@ -69,11 +69,11 @@ Options
  See `Find-Package Tool Mode`_.
 
 ``--graphviz=[file]``
- Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
+ Generate graphviz of dependencies, see :module:`CMakeGraphVizOptions` for more.
 
  Generate a graphviz input file that will contain all the library and
  executable dependencies in the project.  See the documentation for
- CMakeGraphVizOptions.cmake for more details.
+ :module:`CMakeGraphVizOptions` for more details.
 
 ``--system-information [file]``
  Dump information about this system.

+ 7 - 7
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.
 #