C / C++ / 系统课时
为什么构建文件要放到 build
为什么构建文件要放到 build
CMake 会生成缓存、构建系统文件、目标文件和可执行程序。如果把这些内容直接写进源码目录,清理和切换构建配置都会变得麻烦。把生成物统一放进独立的 build 目录,可以让源码保持干净,也便于同时维护多套构建结果。
学习目标
- 使用
cmake -S与-B创建独立构建目录 - 理解源码目录与构建目录各自应该保存什么
- 能安全清理构建结果,并为不同配置使用不同目录
源码目录不应该承担生成物
源码目录适合保存需要版本控制的内容,例如 .c、.h、CMakeLists.txt 和测试数据。CMake 配置后产生的 CMakeCache.txt、生成器文件、目标文件和最终程序,本质上都是可以重新生成的构建产物。
如果在源码目录内直接运行旧式的就地构建,生成文件会与源码混在一起。此时清理不再只是删除一个目录,还可能误删源码或漏掉缓存文件;提交 Git 时,也更容易把无关产物加入仓库。
用独立目录完成一次构建
准备一个最小项目。
CMakeLists.txt:
cmake_minimum_required(VERSION 3.20)
project(out_of_source_demo C)
add_executable(hello main.c)main.c:
#include <stdio.h>
int main(void) {
puts("hello from build directory");
return 0;
}以 Linux 或 macOS 上常见的单配置生成器为例,在项目根目录执行:
cmake -S . -B build >/dev/null
cmake --build build >/dev/null
./build/hello预期输出:
hello from build directoryCMake 的配置日志会因编译器和生成器不同而变化,因此这里不把日志逐行作为固定结果。真正需要验证的是:源码仍留在项目根目录,而缓存和编译产物进入 build;实际可执行文件路径也可能因平台或多配置生成器而不同。
清理为什么更安全
独立构建目录最直接的收益,是“生成物可整体丢弃”。当缓存损坏、生成器切换,或你想从零重新配置时,可以删除整个 build,而不需要逐个辨认文件。
在 Linux 或 macOS 中,可以这样重新开始,并直接检查缓存是否重新生成:
rm -rf build
cmake -S . -B build >/dev/null
test -f build/CMakeCache.txt && printf 'cache recreated\n'预期输出:
cache recreated这里不依赖 CMake 的具体日志内容,而是用 build/CMakeCache.txt 是否重新出现验证独立构建目录已经恢复。
多配置构建更容易共存
独立目录不仅用于清理,也适合并存不同配置。对于单配置生成器,可以分别创建调试版和发布版目录:
cmake -S . -B build-debug -DCMAKE_BUILD_TYPE=Debug >/dev/null
cmake -S . -B build-release -DCMAKE_BUILD_TYPE=Release >/dev/null
test -f build-debug/CMakeCache.txt
test -f build-release/CMakeCache.txt
printf 'two build trees ready\n'预期输出:
two build trees ready这样切换配置时不必反复覆盖同一份缓存。对于 Visual Studio、Xcode 等多配置生成器,通常一个构建目录本身就能保存多个配置,此时应使用 cmake --build <PATH> --config Debug 之类的方式选择配置,而不是依赖 CMAKE_BUILD_TYPE。
把 build 视为“可随时重建的工作区”是最实用的原则:源码进入版本控制,生成物集中留在构建目录,需要清理时整体删除,需要多套配置时使用独立构建目录或生成器自身的多配置能力。