如何正确链接已编译安装到sysroot的静态库revolta

问题场景 #

现有静态库revolta，编译后需安装到指定sysroot目录，现有CMake配置及安装流程可正常完成编译安装，但外部项目链接该库时出现两个问题：

1. 自动添加了revolta的源码路径作为头文件包含路径（该路径已标记为PRIVATE）；
2. 链接的是构建目录中的库文件，而非sysroot中安装的版本。

补充：曾尝试通过gcc的--sysroot=/home/martin/git/revolta/sysroot参数指定sysroot，路径可正常识别，但无法自动触发revolta的编译安装依赖。

核心原因 #

外部项目直接引用了revolta构建过程中的目标对象，而非安装后导出的标准化CMake目标，导致BUILD_INTERFACE的配置（源码路径、构建目录库）被传递给了外部项目，而非预期的INSTALL_INTERFACE配置。

解决方案 #

1. 完善revolta的CMake导出配置 #

要让外部项目能正确识别sysroot中的安装版本，需将revolta的目标配置导出到sysroot，供外部find_package调用：

步骤1：导出目标配置文件

在revolta的CMakeLists.txt中添加install(EXPORT)命令，将目标信息导出到sysroot的cmake配置目录：

# 导出目标配置到sysroot的cmake目录
install(EXPORT ${TARGET_LIBREVOLTA}
    FILE ${TARGET_LIBREVOLTA}Targets.cmake
    NAMESPACE Revolta::  # 命名空间避免目标名冲突
    DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/cmake/${TARGET_LIBREVOLTA}
)

步骤2：生成Config.cmake文件

创建一个revoltaConfig.cmake.in模板文件，内容如下：

@PACKAGE_INIT@

include("${CMAKE_CURRENT_LIST_DIR}/revoltaTargets.cmake")
check_required_components(revolta)

然后在revolta的CMakeLists.txt中添加配置命令，生成并安装该文件：

# 生成并安装Config.cmake文件
configure_file(revoltaConfig.cmake.in ${TARGET_LIBREVOLTA}Config.cmake @ONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_LIBREVOLTA}Config.cmake
    DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/cmake/${TARGET_LIBREVOLTA}
)

2. 确保头文件路径的INTERFACE隔离 #

原有target_include_directories配置无需修改，只要外部项目通过导出目标引用，PRIVATE标记的源码路径就不会传递给外部项目：

target_include_directories( ${TARGET_LIBREVOLTA}
PUBLIC
    $<INSTALL_INTERFACE:${CMAKE_INSTALL_PREFIX}/include>
PRIVATE
    $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}>
)

3. 外部项目的正确引用方式 #

外部项目需通过find_package识别sysroot中的revolta，而非直接引用构建目录的目标：

# 指定sysroot的cmake配置路径（或通过CMAKE_PREFIX_PATH环境变量全局设置）
set(CMAKE_PREFIX_PATH "/home/martin/git/revolta/sysroot/lib/cmake/revolta" ${CMAKE_PREFIX_PATH})

# 查找revolta包
find_package(revolta REQUIRED)

# 链接导出的命名空间目标
target_link_libraries( ${APP_EXECUTABLE}
PRIVATE
    Revolta::revolta
)

4. 自动触发revolta的编译安装依赖（可选） #

如果需要外部项目构建时自动编译并安装revolta到sysroot，可使用ExternalProject_Add管理依赖：

include(ExternalProject)

ExternalProject_Add(revolta_project
    SOURCE_DIR "/home/martin/git/revolta/source/librevolta"
    BINARY_DIR "/home/martin/git/revolta/build/librevolta"
    CMAKE_ARGS
        -DCMAKE_INSTALL_PREFIX=/home/martin/git/revolta/sysroot
    INSTALL_COMMAND ${CMAKE_COMMAND} --install .
)

# 让外部可执行目标依赖revolta的安装目标
add_dependencies(${APP_EXECUTABLE} revolta_project)

验证效果 #

完成配置后，外部项目构建时将：

• 使用sysroot中/home/martin/git/revolta/sysroot/include的头文件；
• 链接sysroot中/home/martin/git/revolta/sysroot/lib/librevolta.a的静态库；
• 若使用ExternalProject_Add，可自动触发revolta的编译安装流程。

内容的提问来源于stack exchange，提问作者Martin Kopecký