跳到主要内容

kmpkg_configure_cmake

注意

此函数已被弃用，建议改用 kmpkg_cmake_configure。

为项目的 Debug 和 Release 版本配置 CMake。

用法​

kmpkg_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​

表明只要 Ninja 可用，kmpkg 就应使用 Ninja 执行构建。 除非已知该端口在 Ninja 环境下无法正常工作，否则都应指定此参数。

DISABLE_PARALLEL_CONFIGURE​

禁用并行执行 CMake 配置步骤。 对于那些在配置阶段会向自身源码目录写入文件的库，需要启用此选项。

该选项同时会禁用 CMAKE_DISABLE_SOURCE_CHANGES 标志。

NO_CHARSET_FLAG​

禁用将 utf-8 作为默认字符集传递给 CMAKE_C_FLAGS 和 CMAKE_CXX_FLAGS。

对于自行设置源代码字符集的库，需要启用此选项。

GENERATOR​

指定要使用的具体生成器。

如果某个项目专属的构建系统被封装在不执行实际构建操作的 CMake 脚本中，此参数会非常有用。 若为此场景使用该参数，应将其设为 "NMake Makefiles"。

OPTIONS​

配置阶段传递给 CMake 的额外选项。

OPTIONS_RELEASE​

仅在 Release 版本配置阶段传递给 CMake 的额外选项。这些选项会附加在 OPTIONS 之后。

OPTIONS_DEBUG​

仅在 Debug 版本配置阶段传递给 CMake 的额外选项。这些选项会附加在 OPTIONS 之后。

MAYBE_UNUSED_VARIABLES​

显式传入、但可能并非在所有平台上都会被使用的 CMake 变量。 示例如下：

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

LOGNAME​

用于写入配置调用输出内容的日志名称。

说明​

此命令会为 CMake 提供许多通用参数。若要查看完整列表，请查阅源码。

源码​

scripts/cmake/kmpkg_configure_cmake.cmake