diff options
Diffstat (limited to 'Modules/CMakeGraphVizOptions.cmake')
-rw-r--r-- | Modules/CMakeGraphVizOptions.cmake | 200 |
1 files changed, 118 insertions, 82 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake index e4af54c0a..420e3a9e7 100644 --- a/Modules/CMakeGraphVizOptions.cmake +++ b/Modules/CMakeGraphVizOptions.cmake @@ -1,83 +1,119 @@ -##section Variables specific to the graphviz support -##end -##module -# - The builtin graphviz support of CMake. -# 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 --graphiz=foo 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 -# -# This can result in huge graphs. Using the file 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 read and the variables set in it -# are used to adjust options for the generated graphviz files. -##end -# -##variable -# GRAPHVIZ_GRAPH_TYPE - The graph type -# Mandatory : NO -# Default : "digraph" -##end -##variable -# GRAPHVIZ_GRAPH_NAME - The graph name. -# Mandatory : NO -# Default : "GG" -##end -##variable -# GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file. -# Mandatory : NO -# Default : "node [n fontsize = "12"];" -##end -##variable -# GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file. -# Mandatory : NO -# Default : "node" -##end -##variable -# GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude static libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets. -# Mandatory : NO -# Default : empty -##end +# Distributed under the OSI-approved BSD 3-Clause License. See accompanying +# file Copyright.txt or https://cmake.org/licensing for details. -#============================================================================= -# Copyright 2007-2009 Kitware, Inc. -# Copyright 2013 Alexander Neundorf <neundorf@kde.org> -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) +#.rst: +# CMakeGraphVizOptions +# -------------------- +# +# The builtin graphviz support of CMake. +# +# Variables specific to the graphviz support +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# 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.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 +# +# This can result in huge graphs. Using the file +# 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 +# read and the variables set in it are used to adjust options for the +# generated graphviz files. +# +# .. variable:: GRAPHVIZ_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. +# +# * Mandatory : NO +# * Default : "GG" +# +# .. variable:: GRAPHVIZ_GRAPH_HEADER +# +# The header written at the top of the graphviz file. +# +# * Mandatory : NO +# * Default : "node [n fontsize = "12"];" +# +# .. variable:: GRAPHVIZ_NODE_PREFIX +# +# The prefix for each node in the graphviz file. +# +# * Mandatory : NO +# * Default : "node" +# +# .. variable:: GRAPHVIZ_EXECUTABLES +# +# Set this to FALSE to exclude executables from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_STATIC_LIBS +# +# Set this to FALSE to exclude static libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_SHARED_LIBS +# +# Set this to FALSE to exclude shared libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_MODULE_LIBS +# +# Set this to FALSE to exclude module libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_EXTERNAL_LIBS +# +# Set this to FALSE to exclude external libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_IGNORE_TARGETS +# +# A list of regular expressions for ignoring targets. +# +# * Mandatory : NO +# * Default : empty +# +# .. variable:: GRAPHVIZ_GENERATE_PER_TARGET +# +# Set this to FALSE to exclude per target graphs ``foo.dot.<target>``. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_GENERATE_DEPENDERS +# +# Set this to FALSE to exclude depender graphs ``foo.dot.<target>.dependers``. +# +# * Mandatory : NO +# * Default : TRUE |