diff options
| author | Brad King <brad.king@kitware.com> | 2020-04-23 13:15:10 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-04-23 13:15:24 (GMT) |
| commit | 61ac8e6dfa06d82ff2ef3ae3f0076fb9aa65d542 (patch) | |
| tree | 1aa5e94ee8bbb094e22cc6bd4359443fec07fc93 /Help | |
| parent | b779cb13b4462ad3245a442bb7c8fcd70e3faac6 (diff) | |
| parent | 306a1ba96073175ddc0c4de4d5f17b44d432da33 (diff) | |
| download | CMake-61ac8e6dfa06d82ff2ef3ae3f0076fb9aa65d542.zip CMake-61ac8e6dfa06d82ff2ef3ae3f0076fb9aa65d542.tar.gz CMake-61ac8e6dfa06d82ff2ef3ae3f0076fb9aa65d542.tar.bz2 | |
Merge topic 'remove-documentation-module'
306a1ba960 Modules/Documentation: remove
ad4487a96a cmIncludeCommand: add infrastructure for deprecated modules
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4617
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-policies.7.rst | 1 | ||||
| -rw-r--r-- | Help/policy/CMP0106.rst | 19 | ||||
| -rw-r--r-- | Help/release/dev/deprecate-documentation-module.rst | 6 |
3 files changed, 26 insertions, 0 deletions
diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index ffb4543..3f3b70d 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/Help/manual/cmake-policies.7.rst @@ -57,6 +57,7 @@ Policies Introduced by CMake 3.18 .. toctree:: :maxdepth: 1 + CMP0106: The Documentation module is removed. </policy/CMP0106> CMP0105: Device link step uses the link options. </policy/CMP0105> CMP0104: CMAKE_CUDA_ARCHITECTURES now detected for NVCC, empty CUDA_ARCHITECTURES not allowed. </policy/CMP0104> CMP0103: Multiple export() with same FILE without APPEND is not allowed. </policy/CMP0103> diff --git a/Help/policy/CMP0106.rst b/Help/policy/CMP0106.rst new file mode 100644 index 0000000..e34d15a --- /dev/null +++ b/Help/policy/CMP0106.rst @@ -0,0 +1,19 @@ +CMP0106 +------- + +The :module:`Documentation` module is removed. + +The :module:`Documentation` was added as a support mechanism for the VTK +project and was tuned for that project. Instead of CMake providing this module +with (now old) VTK patterns for cache variables and required packages, the +module is now deprecated by CMake itself. + +The ``OLD`` behavior of this policy is for :module:`Documentation` to add +cache variables and find VTK documentation dependent packages. The ``NEW`` +behavior is to act as an empty module. + +This policy was introduced in CMake version 3.18. CMake version |release| +warns when the policy is not set and uses ``OLD`` behavior. Use the +:command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly. + +.. include:: DEPRECATED.txt diff --git a/Help/release/dev/deprecate-documentation-module.rst b/Help/release/dev/deprecate-documentation-module.rst new file mode 100644 index 0000000..5c3157b --- /dev/null +++ b/Help/release/dev/deprecate-documentation-module.rst @@ -0,0 +1,6 @@ +deprecate-documentation-module +------------------------------ + +* The :module:`Documentation` module has been deprecated via + :policy:`CMP0106`. This module was essentially VTK code that CMake should + not be shipping anymore. |