cmake 中cmake_file_api 命令的讲解

描述

通过此命令可以查看cmake 构建系统中的信息。

命令模板

cmake_file_api(
  QUERY
  API_VERSION <version>
  [CODEMODEL <versions>...]
  [CACHE <versions>...]
  [CMAKEFILES <versions>...]
  [TOOLCHAINS <versions>...]
)

触发时机

当cmake 生成构建系统时(即在build 路径下中执行“cmake ..”）

结果

会在build 目录下生成.cmake/api/v1/reply

关于reply下文件的字段的详细介绍，请看 cmake-file-api(7) — CMake 3.29.0-rc3 Documentation

切换到你自己安装的cmake对应的版本即可。你可以执行cmake --version 来查看cmake 的版本。

用途

方便我们查看或者验证cmake 构建系统里的一些信息

例子

比如我们获取CODEMODEL, TOOLCHAINS 的信息：

在顶层的CMakeLists.txt 中添加如下信息：

cmake_file_api(

   QUERY

  API_VERSION 1

CODEMODEL 2.3

TOOLCHAINS 1.0

)

如何知道你的环境中CODEMODEL，CACHE，CMAKEFILES，TOOLCHAINS对应的version呢？

首先，查看cmake的版本，cmake --version 获取cmake的版本

其次，访问cmake-file-api(7) — CMake 3.29.0-rc3 Documentation 并改成你环境中的版本