Repository navigation
cmake build fails if more than one build_sketch definition is used #2282
Description
Activity
Hello,
IIRC
build_sketch()creates build targets with specific names to handle the Arduino workflow.
These targets always have the same conventional name, so that they can be more easily integrated into the rest of the project. (variantis one, there are others.)Unfortunately, this means than no more than one sketch is supported per CMake project.
I think it's possible to change the name of the conventional targets to include some sketch-specific prefix. If you're interested in developing this, please feel free! - assuming @fpistm agrees on the idea ;)
Reacted by Frederic PillonThe targets that cause a clash seem to be more dependant on the variant selected and this is controlled by set_board and should not really change on a per sketch basis. I thin redefining them in each sketch is the issue.
You're right. I have studied the issue in a bit more depth, and the limitation you're running into is that each variant has its own CMakeLists.txt file which defines a target named
variant.The simplest solution is, I think, to move the
add_subdirectory()calls you pointed out earlier outside ofbuild_sketch()(directly at file level, underinclude(set_base_arduino_config)).
This would have to be thoroughly documented in the wiki, however:- importing
build_sketch.cmakehas side-effects - importing
build_sketch.cmakeshould only happen once - having several sketches with different targets / configs is not supported.
- importing
Moving the
add_subdirectory()calls out of the function definition works in my use-case. If we are concerned about importing build_sketch.cmake more than once the we could useinclude_guard()on the file. I understand having different configs is not supported but I don't think this would be a very common case. If you were building for different boards or settings this can be handled by having different build directories where cmake is run with different defines.
The case I am trying to address is a library with multiple small programs to unit test the functionality and to provide some user examples. When doing embedded development I like to keep a few very small and simple test programs around for when the whole board just starts misbehaving. You need this to determine if you are fighting a software or hardware issue.Reacted by Alexis MassonHey, I'm glad this solution works for you. Also, I did not know about
include_guard(); it would definitely be a good addition in most files in stm32duino's CMake framework.Do you want to implement these changes and propose a pull request?
@massonal I just noticed another issue in
sketch_preprocess_sources.cmake. If you have an .ino file in a subdirectory the dependency fails. Everything is setup correctly but the filename without the flattened${CMAKE_CURRENT_BINARY_DIR}path is added to theSRCLIST.I will get a pull request together with these changes.
*** sketch_preprocess_sources.cmake.orig 2024-02-21 20:52:30.297138663 +1100 --- sketch_preprocess_sources.cmake 2024-02-21 21:02:28.738043288 +1100 *************** *** 27,33 **** COMPILE_OPTIONS "-include;Arduino.h;-include;${SRCFILE}.h" OBJECT_DEPENDS "${SRCFILE}.h" ) ! list(APPEND SRCLIST ${SRCFILE}.cpp) else() list(APPEND SRCLIST ${SRCFILE}) endif() --- 27,33 ---- COMPILE_OPTIONS "-include;Arduino.h;-include;${SRCFILE}.h" OBJECT_DEPENDS "${SRCFILE}.h" ) ! list(APPEND SRCLIST ${CMAKE_CURRENT_BINARY_DIR}/${SRC_BASE_NAME}.cpp) else() list(APPEND SRCLIST ${SRCFILE}) endif()Reacted by Alexis Masson and Frederic Pillon
I am trying to build multiple sketches using a project wide CMakeLists.txt file. If I call the build_sketch() function with each of the targets then cmake reports an error about duplicated targets:
I have tried various cmake property settings but the error persists. I was able to get the builds to work by putting an
if (NOT TARGET variant)guard around the add_subdirectory calls in build_sketch.cmake.If there is a better solution then I would love to know otherwise I can submit a pull request.