summaryrefslogtreecommitdiffstats
path: root/Modules/Documentation.cmake
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2020-04-16 13:37:45 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2020-04-22 14:46:03 (GMT)
commit306a1ba96073175ddc0c4de4d5f17b44d432da33 (patch)
treee1d867f9aa6cc29ca178fbc8bde13fc92510d991 /Modules/Documentation.cmake
parentad4487a96ae6e7e93e9b14d0fee67da01e27e12a (diff)
downloadCMake-306a1ba96073175ddc0c4de4d5f17b44d432da33.zip
CMake-306a1ba96073175ddc0c4de4d5f17b44d432da33.tar.gz
CMake-306a1ba96073175ddc0c4de4d5f17b44d432da33.tar.bz2
Modules/Documentation: remove
This is an old module from when VTK and other Kitware projects drove the addition of commands and modules into CMake itself. Modern VTK doesn't need this module and it can be ignored. This module is kept around so that the ancient VTK versions which use it are not broken by it. VTK itself stopped using the module in 2012 and the last usage by an example in VTK was removed in 2020. Fixes: #20591
Diffstat (limited to 'Modules/Documentation.cmake')
-rw-r--r--Modules/Documentation.cmake28
1 files changed, 28 insertions, 0 deletions
diff --git a/Modules/Documentation.cmake b/Modules/Documentation.cmake
index aaf24f6..c297231 100644
--- a/Modules/Documentation.cmake
+++ b/Modules/Documentation.cmake
@@ -9,6 +9,30 @@ This module provides support for the VTK documentation framework. It
relies on several tools (Doxygen, Perl, etc).
#]=======================================================================]
+cmake_policy(GET CMP0106 _Documentation_policy)
+
+if (_Documentation_policy STREQUAL "NEW")
+ message(FATAL_ERROR
+ "Documentation.cmake is VTK-specific code and should not be used in "
+ "non-VTK projects. This logic in this module is best shipped with the "
+ "project using it rather than with CMake. This is now an error according "
+ "to policy CMP0106.")
+else ()
+
+if (_Documentation_policy STREQUAL "")
+ # Ignore the warning if the project is detected as VTK itself.
+ if (NOT CMAKE_PROJECT_NAME STREQUAL "VTK" AND
+ NOT PROJECT_NAME STREQUAL "VTK")
+ cmake_policy(GET_WARNING CMP0106 _Documentation_policy_warning)
+ message(AUTHOR_WARNING
+ "${_Documentation_policy_warning}\n"
+ "Documentation.cmake is VTK-specific code and should not be used in "
+ "non-VTK projects. This logic in this module is best shipped with the "
+ "project using it rather than with CMake.")
+ endif ()
+ unset(_Documentation_policy_warning)
+endif ()
+
#
# Build the documentation ?
#
@@ -44,3 +68,7 @@ if (BUILD_DOCUMENTATION)
#
endif ()
+
+endif ()
+
+unset(_Documentation_policy)