summaryrefslogtreecommitdiff
path: root/Modules/CMakeGraphVizOptions.cmake
blob: 63009dcb06e95a41658373267affab9ff7890988 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#.rst:
# CMakeGraphVizOptions
# --------------------
#
# The builtin graphviz support of CMake.
#
# #section Variables specific to the graphviz support #end #module 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 module 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

#=============================================================================
# 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.)