深入理解 CMake 的 `cmake --build` 命令

时间：2025-03-15 09:31:42

引言

CMake 是一个跨平台的自动化构建系统，广泛用于编译和管理复杂的软件项目。它使用配置文件 来生成适用于不同平台的构建系统。cmake --build 是 CMake 命令行工具的一个功能，用于编译项目。在这篇博客中，我们将探讨 cmake --build 的使用方式以及如何通过扩展代码来增强其功能。

什么是 cmake --build？

cmake --build 是 CMake 工具的一个命令行选项，它允许用户直接从命令行启动构建过程。这个命令特别有用，因为它可以与 CMake 生成的构建系统（如 Unix Makefiles 或 Ninja）无缝集成。

基本用法

假设你已经使用 CMake 成功配置了你的项目，并且生成了构建系统。要编译项目，你可以进入构建目录并运行以下命令：

cmake --build .

这里的 . 表示当前目录，即构建目录。CMake 会调用默认的构建工具（如 make 或 ninja）来编译项目。

指定构建目录

如果你想要指定一个自定义的构建目录，可以使用 -B 选项：

cmake -B my_build_dir -S .

这条命令会告诉 CMake 创建一个名为 my_build_dir 的目录（如果它不存在的话），并在该目录下生成构建文件。

高级用法

cmake --build 还支持一些高级选项，例如：

  • --config <Config>：指定构建配置（如 Debug, Release 等）。
  • --parallel 或 -- -j<jobs>：使用多线程或指定工作线程数来加速构建过程。
  • --target <Target>：指定构建特定的目标（如可执行文件或库）。

扩展代码示例

有时你可能需要在构建过程中执行一些自定义的脚本或命令。CMake 提供了一些机制来实现这一点，例如使用 add_custom_command 或 add_custom_target。

以下是一个简单的 文件示例，展示了如何在构建过程中添加自定义命令：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 添加可执行文件
add_executable(my_executable )

# 添加自定义命令，用于在构建之前执行
add_custom_command(
    OUTPUT ${CMAKE_BINARY_DIR}/pre_build_script_output.txt
    COMMAND ${CMAKE_COMMAND} -E echo "Pre-build script is running"
    COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_BINARY_DIR}/pre_build_script_output.txt
    DEPENDS 
)

# 添加自定义目标，用于在构建过程中执行
add_custom_target(
    run_custom_command
    DEPENDS ${CMAKE_BINARY_DIR}/pre_build_script_output.txt
    COMMAND ${CMAKE_COMMAND} -E echo "Running custom command after pre-build script"
)

在这个示例中，我们定义了一个自定义命令，它会在构建之前运行，并创建一个标记文件。我们还定义了一个自定义目标，它会在自定义命令完成后执行。

结语

cmake --build 是一个强大的工具，它简化了编译过程并提供了与构建系统的深度集成。通过一些高级选项和扩展代码，你可以定制构建过程以满足特定的需求。希望这篇博客能帮助你更好地理解和使用 CMake 的这一功能。

分享一个有趣的 学习链接

相关文章