CMake：如何在包含的标头更改时自动重建 .obj 文件答案

【问题标题】：CMake: How to automatically rebuild .obj-files when included header changedCMake：如何在包含的标头更改时自动重建 .obj 文件
【发布时间】：2019-10-05 07:27:19
【问题描述】：

根据我自己的搜索，我不确定“正常”行为是什么：当相关源文件中包含的标头发生更改时，CMake 通常会重建 .obj 文件吗？因为它在我的项目中根本没有这样做。这是我的顶级 CMakeLists.txt：

cmake_minimum_required(VERSION 3.15 FATAL_ERROR)

enable_language(CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# project and binary name
project("myProjectName")


# compiler specific warnings
# and warnings are treated as errors
if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR
    "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
    set(warnings "-Wall -Wextra -Werror")
elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
    set(warnings "/W4 /WX /EHsc")
endif()
if (NOT CONFIGURED_ONCE)
    set(CMAKE_CXX_FLAGS "${warnings}"
        CACHE STRING "Flags used by the compiler during all build types." FORCE)
    set(CMAKE_C_FLAGS   "${warnings}"
        CACHE STRING "Flags used by the compiler during all build types." FORCE)
endif()

# default build-type is Debug:

if (NOT CMAKE_BUILD_TYPE)
    set(CMAKE_BUILD_TYPE "Debug")
endif()


# =============================
# libraries
# =============================

# external
# eigen numerics library
find_package (Eigen3 3.3 REQUIRED NO_MODULE)
set( EIGEN Eigen3::Eigen )

# some internal libraries here
set( LIB_NAME_1 lib1 )
set( LIB_NAME_2 lib2 )


# =============================
# directory configuration
# =============================

# for finding libraries and such in the project's subdirectories
# all paths are prepended with the project's root directory
set(CMAKE_PREFIX_PATH ${CMAKE_SOURCE_DIR})

# specifiying output directories 
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
#set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
# the last one is disabled to allow for tests in a different directory

# include paths
include_directories(
    ${CMAKE_SOURCE_DIR}/include
    ${CMAKE_SOURCE_DIR}/lib # I put header-only libraries there
    ${CMAKE_SOURCE_DIR}/src # for template definitions
)


# =============================
# unit test configuration
# =============================
# enable_testing() sets the internal flag "CMAKE_TESTING_ENABLED" to 1
# add_test() commands are only run when enable_testing() has executed.
# here, it is only executed in debug mode
if(CMAKE_BUILD_TYPE MATCHES Debug)
    enable_testing()
endif()


# the unit test framework used here is "Catch2" (single header file "catch.hpp")
# (https://github.com/catchorg/Catch2)

if ( ${CMAKE_TESTING_ENABLED} )
    message( "-- Tests are enabled" )
    set( UNIT_TEST_LIB catch2 )
endif()


# =============================
# subdir calls
# =============================
# the second parameter specifies the output path for binaries.
# however, the respective CMAKE_XYZ_OUTPUT_DIRECTORY takes precedence
add_subdirectory(lib)
add_subdirectory(src bin)

if ( ${CMAKE_TESTING_ENABLED} )
    add_subdirectory(tests tests)
endif()

然后我在 lib、src 和测试中有另一个 CMakeLists.txt。这些仅包含使用适当源文件的addLibrary、addExecutable 和targetLinkLibraries 命令。除了在“测试”中，还有addTest 和addCustomCommand 使单元测试可执行文件在构建后运行。

问题是：我是否遗漏了某些内容，并且应该在标题更改时重建 (1)？还是这是正常行为 (2)？

Make doesn't rebuild headers when changed

GCC included header (using -include) changes not detected by CMake

【问题讨论】：

仅当标头与源文件一起添加到该目标时。在您的情况下，在子目录lib/src/tests.

标签： c++ cmake header-files

【解决方案1】：

当标头更改时，CMake 会重建目标文件，但是 CMake 3.15 有一个错误，即它不能正常用于 make 目标。我也遇到了这个问题，发现已经报了：https://gitlab.kitware.com/cmake/cmake/issues/19507

在 3.15.1 中已修复，因此解决方案是升级（可能将 cmake_minimum_required 更改为 3.15.1）。

【讨论】：