CMake/Help/variable/CMAKE_POLICY_VERSION_MINIMUM.rst
Brad King 1a35351125 Add CMAKE_POLICY_VERSION_MINIMUM to help configure outdated projects
Provide packagers and end users with a way to try configuring projects that
have not been updated to set their policy version to a supported level.

Closes: #26698
2025-02-13 14:00:26 -05:00

24 lines
1016 B
ReStructuredText

CMAKE_POLICY_VERSION_MINIMUM
----------------------------
.. versionadded:: 4.0
Specify a minimum :ref:`Policy Version` for a project without modifying
its calls to :command:`cmake_minimum_required(VERSION)` and
:command:`cmake_policy(VERSION)`.
This variable should not be set by a project in CMake code as a way to
set its own policy version. Use :command:`cmake_minimum_required(VERSION)`
and/or :command:`cmake_policy(VERSION)` for that. This variable is meant
to externally set policies for which a project has not itself been updated:
* Users running CMake may set this variable in the cache, e.g.,
``-DCMAKE_POLICY_VERSION_MINIMUM=3.5``, to try configuring a project
that has not been updated to set at least that policy version itself.
* Projects may set this variable before a call to :command:`add_subdirectory`
that adds a third-party project in order to set its policy version without
modifying third-party code.
See :variable:`CMAKE_POLICY_DEFAULT_CMP<NNNN>` to set individual policies.