如何让项目用户配置专属CMAKE_PREFIX_PATH且拉分支不覆盖？

以下几种方案可以实现本地路径配置不被分支拉取覆盖，同时避免重复输入或频繁修改CMakeLists.txt：

1. 本地私有CMake配置文件（不纳入版本控制） #

• 在项目根目录新建一个本地配置文件，比如LocalPaths.cmake，写入你的库路径配置：

  list(APPEND CMAKE_PREFIX_PATH "/你的本地第三方库安装路径")
  

• 修改项目主CMakeLists.txt，在project()指令之后添加如下代码，让CMake自动加载本地配置（如果存在）：

  if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/LocalPaths.cmake")
      include(${CMAKE_CURRENT_SOURCE_DIR}/LocalPaths.cmake)
  endif()
  

• 将LocalPaths.cmake加入项目的.gitignore文件，确保它不会被提交到代码仓库，拉取新分支时也不会被覆盖。

2. CMake用户预设文件 #

CMake支持通过预设文件保存本地配置，其中CMakeUserPresets.json是专门用于本地用户的配置文件，默认不会被版本控制系统追踪：

• 在项目根目录创建CMakeUserPresets.json，示例内容如下：

  {
    "version": 3,
    "configurePresets": [
      {
        "name": "local-dev",
        "cacheVariables": {
          "CMAKE_PREFIX_PATH": "/你的本地第三方库安装路径"
        }
      }
    ]
  }
  

• 配置项目时直接调用预设：cmake --preset local-dev，Windows下Visual Studio也可以在"CMake设置"中选择该预设，无需每次手动输入路径参数。

3. 系统环境变量 #

利用CMake自动读取环境变量的特性，将库路径设置到系统环境变量中：

• Linux/macOS：在终端配置文件（如.bashrc、.zshrc）中添加：

  export CMAKE_PREFIX_PATH="/你的本地第三方库安装路径:$CMAKE_PREFIX_PATH"
  

• Windows：在系统环境变量中新增CMAKE_PREFIX_PATH，值设为你的第三方库安装路径（多路径用分号;分隔）。
• 此后每次CMake配置时会自动加载该环境变量中的路径，无需额外参数，分支拉取也不会影响本地环境变量配置。

内容的提问来源于stack exchange，提问作者willem