cmake_minimum_required

Требуется минимальная версия cmake.

cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])

Новая в версии 3.12: Необязательная <policy_max> версия.

Устанавливает минимально необходимую версию cmake для проекта. Также обновляет настройки политики, как описано ниже.

<min> и необязательная <policy_max> — это версии CMake, имеющие формат major.minor[.patch[.tweak]], а ... — это литерал.

Если текущая версия CMake ниже требуемой <min>, обработка проекта будет остановлена, и будет сообщено об ошибке. Необязательная версия <policy_max>, если указана, должна быть не ниже <min> версии и влияет на настройки политики, как описано в Настройках политики. Если текущая версия CMake старше 3.12, дополнительные ... точки будут восприниматься как разделители компонентов версии, в результате чего часть ...<max> будет проигнорирована, и будет сохранён прежний до 3.12 механизм определения политики на основе <min>.

Эта команда установит значение переменной CMAKE_MINIMUM_REQUIRED_VERSION на <min>.

Опция FATAL_ERROR принимается, но игнорируется CMake 2.6 и выше. Она должна быть указана, чтобы версии CMake 2.4 и ниже завершались с ошибкой, а не просто предупреждением.

Примечание

Вызовите команду cmake_minimum_required() в начале файла верхнего уровня CMakeLists.txt даже до вызова команды project(). Важно установить настройки версии и политики до вызова других команд, поведение которых они могут повлиять. См. также политику CMP0000.

Вызов cmake_minimum_required() внутри function() ограничивает некоторые эффекты областью действия функции при вызове. Например, переменная CMAKE_MINIMUM_REQUIRED_VERSION не будет установлена в вызывающей области. Функции не вводят свою собственную область политики, поэтому настройки политики вызывающей стороны будут изменены (см. ниже). Из-за этого смешения того, что влияет и что не влияет на вызывающую область, вызов cmake_minimum_required() внутри функции, как правило, не рекомендуется.

Настройки политики

Команда cmake_minimum_required(VERSION) неявно вызывает команду cmake_policy(VERSION), чтобы указать, что текущий проект написан для указанного диапазона версий CMake. Все политики, известные текущей версии CMake и введённые в версии <min> (или <max>, если указана) или ранее, будут установлены с использованием NEW поведения. Все политики, введённые в более поздних версиях, будут сброшены. Это фактически запрашивает поведение, предпочтительное по состоянию на определённую версию CMake, и сообщает более новым версиям CMake о новых политиках.

Когда версия <min> выше 2.4, команда неявно вызывает

cmake_policy(VERSION <min>[...<max>])

что устанавливает политики CMake на основе указанного диапазона версий. Когда версия <min> 2.4 или ниже, команда неявно вызывает

cmake_policy(VERSION 2.4[...<max>])

что активирует совместимые функции для CMake 2.4 и ниже.

Изменено в версии 3.27: Совместимость с версиями CMake, более старыми чем 3.5, устарела. Вызовы cmake_minimum_required(VERSION) или cmake_policy(VERSION), которые не указывают как минимум 3.5 в качестве версии политики (необязательно через ...<max>) будут генерировать предупреждение об устаревании в CMake 3.27 и выше.

Изменено в версии 3.19: Совместимость с версиями CMake, более старыми чем 2.8.12, устарела. Вызовы cmake_minimum_required(VERSION) или cmake_policy(VERSION), которые не указывают как минимум 2.8.12 в качестве версии политики (необязательно через ...<max>) будут генерировать предупреждение об устаревании в CMake 3.19 и выше.

См. также

cmake_policy()

© 2000–2024 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.29/command/cmake_minimum_required.html