diff options
author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 13:23:23 -0400 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 09:22:39 -0400 |
commit | a77e3086938d46c56f62901531245711dbd55cc4 (patch) | |
tree | 310f64bed6b69c741cbd1ec4e2be8177004d86e2 /Modules/CMakeGraphVizOptions.cmake | |
parent | e7ca48f226782e7354a7ea9d6f9cef58e8773306 (diff) | |
download | cmake-a77e3086938d46c56f62901531245711dbd55cc4.tar.gz |
CPack: Replace #<type> markup with reStructuredText equivalent
Drop #end and #module. Convert #section to a subsection header.
Convert #variable to the cmake domain "variable" directive.
Convert #macro to the cmake domain "command" directive.
Perform minor formatting fixes in text near these changes.
Diffstat (limited to 'Modules/CMakeGraphVizOptions.cmake')
-rw-r--r-- | Modules/CMakeGraphVizOptions.cmake | 109 |
1 files changed, 48 insertions, 61 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake index 63009dcb06..f2b8e59765 100644 --- a/Modules/CMakeGraphVizOptions.cmake +++ b/Modules/CMakeGraphVizOptions.cmake @@ -4,108 +4,95 @@ # # The builtin graphviz support of CMake. # -# #section Variables specific to the graphviz support #end #module 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 --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 -# -# +# * 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 +# generated graphviz files. # -# :: +# .. variable:: GRAPHVIZ_GRAPH_TYPE # -# GRAPHVIZ_GRAPH_TYPE - The graph type -# Mandatory : NO -# Default : "digraph" +# The graph type # -# #end #variable +# * Mandatory : NO +# * Default : "digraph" # -# :: +# .. variable:: GRAPHVIZ_GRAPH_NAME # -# GRAPHVIZ_GRAPH_NAME - The graph name. -# Mandatory : NO -# Default : "GG" +# The graph name. # -# #end #variable +# * Mandatory : NO +# * Default : "GG" # -# :: +# .. variable:: GRAPHVIZ_GRAPH_HEADER # -# GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file. -# Mandatory : NO -# Default : "node [n fontsize = "12"];" +# The header written at the top of the graphviz file. # -# #end #variable +# * Mandatory : NO +# * Default : "node [n fontsize = "12"];" # -# :: +# .. variable:: GRAPHVIZ_NODE_PREFIX # -# GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file. -# Mandatory : NO -# Default : "node" +# The prefix for each node in the graphviz file. # -# #end #variable +# * Mandatory : NO +# * Default : "node" # -# :: +# .. variable:: GRAPHVIZ_EXECUTABLES # -# GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs. -# Mandatory : NO -# Default : TRUE +# Set this to FALSE to exclude executables from the generated graphs. # -# #end #variable +# * Mandatory : NO +# * Default : TRUE # -# :: +# .. variable:: GRAPHVIZ_STATIC_LIBS # -# GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE +# Set this to FALSE to exclude static libraries from the generated graphs. # -# #end #variable +# * Mandatory : NO +# * Default : TRUE # -# :: +# .. variable:: GRAPHVIZ_SHARED_LIBS # -# GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE +# Set this to FALSE to exclude shared libraries from the generated graphs. # -# #end #variable +# * Mandatory : NO +# * Default : TRUE # -# :: +# .. variable:: GRAPHVIZ_MODULE_LIBS # -# GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude module libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE +# Set this to FALSE to exclude module libraries from the generated graphs. # -# #end #variable +# * Mandatory : NO +# * Default : TRUE # -# :: +# .. variable:: GRAPHVIZ_EXTERNAL_LIBS # -# GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE +# Set this to FALSE to exclude external libraries from the generated graphs. # -# #end #variable +# * Mandatory : NO +# * Default : TRUE # -# :: +# .. variable:: GRAPHVIZ_IGNORE_TARGETS # -# GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets. -# Mandatory : NO -# Default : empty +# A list of regular expressions for ignoring targets. # -# #end +# * Mandatory : NO +# * Default : empty #============================================================================= # Copyright 2007-2009 Kitware, Inc. |