Commit 7ed35aa3 authored by Jano Svitok's avatar Jano Svitok Committed by Jano Svitok
Browse files

Docs: Improve markup for graphviz related documentation

- add hyperlink to CMakeGraphVizOptions.cmake in cmake(1)
- improve markup in CMakeGraphVizOptions.cmake
parent 8362db82
...@@ -69,11 +69,11 @@ Options ...@@ -69,11 +69,11 @@ Options
See `Find-Package Tool Mode`_. See `Find-Package Tool Mode`_.
``--graphviz=[file]`` ``--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 Generate a graphviz input file that will contain all the library and
executable dependencies in the project. See the documentation for executable dependencies in the project. See the documentation for
CMakeGraphVizOptions.cmake for more details. :module:`CMakeGraphVizOptions` for more details.
``--system-information [file]`` ``--system-information [file]``
Dump information about this system. Dump information about this system.
......
...@@ -11,19 +11,19 @@ ...@@ -11,19 +11,19 @@
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
# #
# CMake # 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 # 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: # produce:
# #
# * a foo.dot file showing all dependencies in the project # * 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>`` 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.<target>.dependers`` file, showing which other targets depend on the respective target
# #
# This can result in huge graphs. Using the file # 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 # 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 # read and the variables set in it are used to adjust options for the
# generated graphviz files. # generated graphviz files.
# #
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment