sof/scripts/cmake/git-submodules.cmake

57 lines
2.0 KiB
CMake

# SPDX-License-Identifier: BSD-3-Clause
find_package(Git)
set(RIMAGE_CMAKE "${SOF_ROOT_SOURCE_DIRECTORY}/rimage/CMakeLists.txt")
if(GIT_FOUND AND EXISTS "${SOF_ROOT_SOURCE_DIRECTORY}/.git")
if(EXISTS "${RIMAGE_CMAKE}")
# As incredible as it sounds, some people run neither
# "git status" nor "git diff" every few minutes and not
# even when their build fails. There has been reports
# that they're puzzled when they miss a required
# submodule update. This is an attempt to draw their
# attention based on the assumption that they pay more
# attention to the CMake logs. The warning can be
# silenced with I_KNOW_SUBMODULES, see below.
execute_process(COMMAND ${GIT_EXECUTABLE} submodule status --recursive
WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
OUTPUT_VARIABLE stdout
RESULT_VARIABLE status)
if(NOT "${status}" EQUAL "0")
# stderr was passed-through
message(FATAL_ERROR
"git submodule status --recursive failed, returned: ${status}\n${stdout}")
endif()
if(NOT "$ENV{I_KNOW_SUBMODULES}" AND
("${stdout}" MATCHES "^[^ ]" OR "${stdout}" MATCHES "\n[^ ]"))
message(WARNING
"There are submodule changes, check git status and git diff\n${stdout}")
endif()
elseif(NOT BUILD_UNIT_TESTS AND
NOT CONFIG_LIBRARY)
# Automated initialization for convenience. You can defeat it by
# manually initializing rimage and _not_ some other
# submodule. In that case you get the warning above.
# TODO: get rid of this CMake configuration time
# hack. Downloading, configuring and building should always be
# kept separate; that's CI 101.
message(STATUS "Git submodules update HACK")
execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --merge --recursive
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
RESULT_VARIABLE GIT_SUBMOD_RESULT)
if(NOT GIT_SUBMOD_RESULT EQUAL "0")
message(FATAL_ERROR "git submodule update --init failed with ${GIT_SUBMOD_RESULT}, please checkout submodules")
endif()
endif() # rimage/CMakeLists.txt
endif() # .git/