CMakeGraphVizOptions.cmake 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. #.rst:
  2. # CMakeGraphVizOptions
  3. # --------------------
  4. #
  5. # The builtin graphviz support of CMake.
  6. #
  7. # Variables specific to the graphviz support
  8. # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  9. #
  10. # CMake
  11. # can generate graphviz files, showing the dependencies between the
  12. # targets in a project and also external libraries which are linked
  13. # against. When CMake is run with the --graphviz=foo option, it will
  14. # produce
  15. #
  16. # * a foo.dot file showing all dependencies in the project
  17. # * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
  18. # * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
  19. #
  20. # This can result in huge graphs. Using the file
  21. # CMakeGraphVizOptions.cmake the look and content of the generated
  22. # graphs can be influenced. This file is searched first in
  23. # ${CMAKE_BINARY_DIR} and then in ${CMAKE_SOURCE_DIR}. If found, it is
  24. # read and the variables set in it are used to adjust options for the
  25. # generated graphviz files.
  26. #
  27. # .. variable:: GRAPHVIZ_GRAPH_TYPE
  28. #
  29. # The graph type
  30. #
  31. # * Mandatory : NO
  32. # * Default : "digraph"
  33. #
  34. # .. variable:: GRAPHVIZ_GRAPH_NAME
  35. #
  36. # The graph name.
  37. #
  38. # * Mandatory : NO
  39. # * Default : "GG"
  40. #
  41. # .. variable:: GRAPHVIZ_GRAPH_HEADER
  42. #
  43. # The header written at the top of the graphviz file.
  44. #
  45. # * Mandatory : NO
  46. # * Default : "node [n fontsize = "12"];"
  47. #
  48. # .. variable:: GRAPHVIZ_NODE_PREFIX
  49. #
  50. # The prefix for each node in the graphviz file.
  51. #
  52. # * Mandatory : NO
  53. # * Default : "node"
  54. #
  55. # .. variable:: GRAPHVIZ_EXECUTABLES
  56. #
  57. # Set this to FALSE to exclude executables from the generated graphs.
  58. #
  59. # * Mandatory : NO
  60. # * Default : TRUE
  61. #
  62. # .. variable:: GRAPHVIZ_STATIC_LIBS
  63. #
  64. # Set this to FALSE to exclude static libraries from the generated graphs.
  65. #
  66. # * Mandatory : NO
  67. # * Default : TRUE
  68. #
  69. # .. variable:: GRAPHVIZ_SHARED_LIBS
  70. #
  71. # Set this to FALSE to exclude shared libraries from the generated graphs.
  72. #
  73. # * Mandatory : NO
  74. # * Default : TRUE
  75. #
  76. # .. variable:: GRAPHVIZ_MODULE_LIBS
  77. #
  78. # Set this to FALSE to exclude module libraries from the generated graphs.
  79. #
  80. # * Mandatory : NO
  81. # * Default : TRUE
  82. #
  83. # .. variable:: GRAPHVIZ_EXTERNAL_LIBS
  84. #
  85. # Set this to FALSE to exclude external libraries from the generated graphs.
  86. #
  87. # * Mandatory : NO
  88. # * Default : TRUE
  89. #
  90. # .. variable:: GRAPHVIZ_IGNORE_TARGETS
  91. #
  92. # A list of regular expressions for ignoring targets.
  93. #
  94. # * Mandatory : NO
  95. # * Default : empty
  96. #
  97. # .. variable:: GRAPHVIZ_GENERATE_PER_TARGET
  98. #
  99. # Set this to FALSE to exclude per target graphs ``foo.dot.<target>``.
  100. #
  101. # * Mandatory : NO
  102. # * Default : TRUE
  103. #
  104. # .. variable:: GRAPHVIZ_GENERATE_DEPENDERS
  105. #
  106. # Set this to FALSE to exclude depender graphs ``foo.dot.<target>.dependers``.
  107. #
  108. # * Mandatory : NO
  109. # * Default : TRUE
  110. #=============================================================================
  111. # Copyright 2007-2009 Kitware, Inc.
  112. # Copyright 2013 Alexander Neundorf <neundorf@kde.org>
  113. #
  114. # Distributed under the OSI-approved BSD License (the "License");
  115. # see accompanying file Copyright.txt for details.
  116. #
  117. # This software is distributed WITHOUT ANY WARRANTY; without even the
  118. # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  119. # See the License for more information.
  120. #=============================================================================
  121. # (To distribute this file outside of CMake, substitute the full
  122. # License text for the above reference.)