如何让CMakeLists.txt中的编译选项始终生效，不受CMake缓存影响？

问题描述 #

在CMakeLists.txt中通过option指令设置编译选项（如MY_BUILD_FLAG），该选项会通过configure_file生成头文件中的编译常量。但CMake的缓存机制会保留选项旧值，导致修改CMakeLists.txt中的选项默认值后，执行cmake .无法生效，必须删除缓存文件才行。不想禁用缓存（大型项目依赖缓存缩短构建时间），但希望构建始终与CMakeLists.txt中的设置同步，同时之前尝试将option改为set也未成功。

错误原因分析 #

你修改后的set写法存在语法错误：set(MY_BUILD_FLAG "bla" OFF)不符合CMake缓存变量的设置规则。正确的缓存变量设置需要指定CACHE关键字、变量类型和描述，且如果不添加FORCE，CMake依然会优先使用已有的缓存值，不会更新为新的默认值。

解决方案 #

1. 强制更新缓存值（适用于需CMakeLists.txt作为权威配置的场景） #

使用set指令并添加FORCE关键字，强制覆盖缓存中的旧值，确保每次执行cmake时都会使用CMakeLists.txt中的最新设置：

cmake_minimum_required(VERSION 3.10)
project(Test VERSION 1.0)
# 强制将MY_BUILD_FLAG的缓存值更新为OFF，类型为BOOL，描述为"bla"
set(MY_BUILD_FLAG OFF CACHE BOOL "bla" FORCE)
configure_file(TestConfig.h.in TestConfig.h)

注意：此方法会覆盖用户通过命令行（如cmake -DMY_BUILD_FLAG=ON .）或cmake-gui手动设置的值，适合要求配置完全由CMakeLists.txt控制的场景。

2. 先清除缓存再重新设置选项 #

先通过unset清除变量的缓存条目，再使用option设置默认值，这样CMake会重新读取CMakeLists.txt中的默认值：

cmake_minimum_required(VERSION 3.10)
project(Test VERSION 1.0)
# 清除缓存中的MY_BUILD_FLAG条目
unset(MY_BUILD_FLAG CACHE)
# 重新设置选项，此时会使用新的默认值
option(MY_BUILD_FLAG "bla" OFF)
configure_file(TestConfig.h.in TestConfig.h)

优点：如果用户之前手动修改过选项值，下次运行CMake时会重新提示设置（交互模式下），兼顾默认配置和用户自定义需求。

3. 使用Out-of-Source构建（最推荐的长期解决方案） #

避免在源码目录下直接运行cmake .，而是创建独立的构建目录，不同配置使用不同的目录（如build-debug、build-release），彻底避免缓存冲突：

# 创建并进入debug构建目录
mkdir build-debug && cd build-debug
cmake .. -DMY_BUILD_FLAG=OFF
# 创建并进入release构建目录
mkdir build-release && cd build-release
cmake .. -DMY_BUILD_FLAG=ON

优点：不同配置的缓存完全隔离，无需手动清除缓存，适合多配置并行开发，也是CMake官方推荐的工作流。

内容的提问来源于stack exchange，提问作者Wör Du Schnaffzig