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