vcpkg_configure_cmake

Статья
01/10/2024

Предупреждение

Эта функция не рекомендуется использовать в пользу vcpkg_cmake_configure.

Настройте CMake для сборок отладки и выпуска проекта.

Использование

vcpkg_configure_cmake(
    SOURCE_PATH <${SOURCE_PATH}>
    [PREFER_NINJA]
    [DISABLE_PARALLEL_CONFIGURE]
    [NO_CHARSET_FLAG]
    [GENERATOR <"NMake Makefiles">]
    [OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
    [OPTIONS_RELEASE <-DOPTIMIZE=1>...]
    [OPTIONS_DEBUG <-DDEBUGGABLE=1>...]
    [MAYBE_UNUSED_VARIABLES <OPTION_NAME>...]
)

Параметры

SOURCE_PATH

Указывает каталог, содержащий объект CMakeLists.txt. По соглашению это обычно устанавливается в портфайле в качестве переменной SOURCE_PATH.

PREFER_NINJA

Указывает, что при наличии vcpkg должен использовать Ninja для выполнения сборки. Это следует указать, если порт не работает в Ninja.

DISABLE_PARALLEL_CONFIGURE

Отключает выполнение шага настройки CMake параллельно. Это необходимо для библиотек, которые записывают обратно в исходный каталог во время настройки.

Это также отключает CMAKE_DISABLE_SOURCE_CHANGES.

NO_CHARSET_FLAG

Отключает передачу utf-8 в качестве символа CMAKE_C_FLAGS по умолчанию и CMAKE_CXX_FLAGS.

Это необходимо для библиотек, которые задают собственный набор символов исходного кода.

ГЕНЕРАТОР

Указывает точный генератор, используемый.

Это полезно, если определенная для проекта система сборки была упакована в скрипт cmake, который не будет выполнять фактическую сборку. Если используется для этой цели, он должен иметь значение "NMake Makefiles".

ПАРАМЕТРЫ

Дополнительные параметры, передаваемые в CMake во время настройки.

OPTIONS_RELEASE

Дополнительные параметры, передаваемые в CMake во время настройки выпуска. Это в дополнение к OPTIONS.

OPTIONS_DEBUG

Дополнительные параметры, передаваемые в CMake во время настройки отладки. Это в дополнение к OPTIONS.

MAYBE_UNUSED_VARIABLES

Все переменные CMake, которые явно передаются, но которые не могут использоваться на всех платформах. Например:

vcpkg_cmake_configure(
    ...
    OPTIONS
        -DBUILD_EXAMPLE=OFF
    ...
    MAYBE_UNUSED_VARIABLES
        BUILD_EXAMPLE
)

LOGNAME

Имя журнала для записи выходных данных вызова настройки.

Примечания.

Эта команда предоставляет множество распространенных аргументов в CMake. Чтобы просмотреть полный список, изучите источник.

Исходный код

scripts/cmake/vcpkg_configure_cmake.cmake

Поделиться через