doc: Update CMake C++ guide by leducp · Pull Request #16970 · apache/nuttx

leducp · 2025-09-03T07:59:26Z

Summary

Update the CMake C++ guide that is too outdated to be used.

Testing

Ongoing

close #16782

leducp · 2025-09-03T08:01:01Z

ping @trns1997

trns1997 · 2025-09-03T08:38:32Z

I will follow the procedure step by step and get back :)

trns1997 · 2025-09-04T17:59:59Z

@leducp since nuttx-12.10.0 i get the following error when trying to build the app:

➜  build make
[ 33%] Building CXX object src/CMakeFiles/hello.dir/HelloWorld.cpp.obj
[ 66%] Building CXX object src/CMakeFiles/hello.dir/main.cpp.obj
[100%] Linking CXX executable hello
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../libs/libarch.a(stm32_start.o): in function `__start':
stm32_start.c:(.text.__start+0x0): multiple definition of `__start'; /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../startup/crt0.o:crt0.c:(.text.__start+0x0): first defined here
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: warning: hello has a LOAD segment with RWX permissions
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../startup/crt0.o: in function `__start':
crt0.c:(.text.__start+0x38): undefined reference to `_sctors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x3c): undefined reference to `_ectors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x40): undefined reference to `main'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x44): undefined reference to `_sdtors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x48): undefined reference to `_edtors'
Memory region         Used Size  Region Size  %age Used
           flash:       19304 B         1 MB      1.84%
            sram:        1704 B       112 KB      1.49%
make[2]: *** [src/CMakeFiles/hello.dir/build.make:113: src/hello] Error 1
make[1]: *** [CMakeFiles/Makefile2:98: src/CMakeFiles/hello.dir/all] Error 2
make: *** [Makefile:91: all] Error 2

some linker definitions are missing in the recent exports. I think we need to resolve this issue before coming back to this

leducp · 2025-09-05T08:02:13Z

@leducp since nuttx-12.10.0 i get the following error when trying to build the app:

➜  build make
[ 33%] Building CXX object src/CMakeFiles/hello.dir/HelloWorld.cpp.obj
[ 66%] Building CXX object src/CMakeFiles/hello.dir/main.cpp.obj
[100%] Linking CXX executable hello
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../libs/libarch.a(stm32_start.o): in function `__start':
stm32_start.c:(.text.__start+0x0): multiple definition of `__start'; /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../startup/crt0.o:crt0.c:(.text.__start+0x0): first defined here
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: warning: hello has a LOAD segment with RWX permissions
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: /home/thomas/nuttxspace/hellocpp/nuttx-export-12.10.0/scripts/../startup/crt0.o: in function `__start':
crt0.c:(.text.__start+0x38): undefined reference to `_sctors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x3c): undefined reference to `_ectors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x40): undefined reference to `main'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x44): undefined reference to `_sdtors'
/home/thomas/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin/arm-none-eabi-ld: crt0.c:(.text.__start+0x48): undefined reference to `_edtors'
Memory region         Used Size  Region Size  %age Used
           flash:       19304 B         1 MB      1.84%
            sram:        1704 B       112 KB      1.49%
make[2]: *** [src/CMakeFiles/hello.dir/build.make:113: src/hello] Error 1
make[1]: *** [CMakeFiles/Makefile2:98: src/CMakeFiles/hello.dir/all] Error 2
make: *** [Makefile:91: all] Error 2

some linker definitions are missing in the recent exports. I think we need to resolve this issue before coming back to this

Indeed... 😥

leducp · 2025-09-05T09:29:33Z

It seems the build is broken since this commit: 422c439

@trns1997 can you cross check on your side?

trns1997 · 2025-09-05T09:31:35Z

It seems the build is broken since this commit: 422c439

@trns1997 can you cross check on your side?

@leducp , here #16976 (comment) i will resolve this in this PR.

trns1997 · 2025-09-05T15:07:57Z

@leducp if you use this toolchain.cmake the app should build:

set(CMAKE_SYSTEM_NAME Generic)
set(CMAKE_SYSTEM_VERSION 1)
set(NUTTX 1)

set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)

set(NUTTX_PATH ${CMAKE_CURRENT_LIST_DIR}/..)
include(${NUTTX_PATH}/scripts/target.cmake)

set(LINKER_SCRIPT ${NUTTX_PATH}/scripts/${LDNAME})

set(CMAKE_C_FLAGS "${ARCHCPUFLAGS} ${ARCHCFLAGS} -D__NuttX__")
set(CMAKE_CXX_FLAGS "${ARCHCPUFLAGS} ${ARCHCXXFLAGS} -D__NuttX__")

set(CMAKE_C_STANDARD_INCLUDE_DIRECTORIES ${NUTTX_PATH}/include
                                         ${NUTTX_PATH}/arch/chip)

set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES
    ${NUTTX_PATH}/include/${NUTTX_CXX} ${NUTTX_PATH}/include
    ${NUTTX_PATH}/arch/chip)

# Use only crt0.o, not every .o in startup/
set(STARTUP_OBJ ${NUTTX_PATH}/startup/crt0.o)

add_compile_options(-nostdlib)
add_compile_options(-ffunction-sections -fdata-sections)

# same entry used for all build modes in crt0.c and arch/.../xxx_start.c

set(ENTRY_NAME "__start")

set(CMAKE_C_LINK_EXECUTABLE
    "<CMAKE_LINKER> ${LDFLAGS} --entry=${ENTRY_NAME} -T${LINKER_SCRIPT} <OBJECTS> ${STARTUP_OBJS} -o <TARGET> <LINK_LIBRARIES> -L${NUTTX_PATH}/libs --start-group ${LDLIBS} ${EXTRA_LIBS} --end-group"
)
set(CMAKE_CXX_LINK_EXECUTABLE
    "<CMAKE_LINKER> ${LDFLAGS} --entry=${ENTRY_NAME} -T${LINKER_SCRIPT} <OBJECTS> ${STARTUP_OBJS} -o <TARGET> <LINK_LIBRARIES> -L${NUTTX_PATH}/libs --start-group ${LDLIBS} ${EXTRA_LIBS} --end-group"
)

set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)

relates to this comment #16976 (comment)

trns1997 · 2025-09-10T08:57:56Z

@leducp if you use this toolchain.cmake the app should build:

set(CMAKE_SYSTEM_NAME Generic)
set(CMAKE_SYSTEM_VERSION 1)
set(NUTTX 1)

set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)

set(NUTTX_PATH ${CMAKE_CURRENT_LIST_DIR}/..)
include(${NUTTX_PATH}/scripts/target.cmake)

set(LINKER_SCRIPT ${NUTTX_PATH}/scripts/${LDNAME})

set(CMAKE_C_FLAGS "${ARCHCPUFLAGS} ${ARCHCFLAGS} -D__NuttX__")
set(CMAKE_CXX_FLAGS "${ARCHCPUFLAGS} ${ARCHCXXFLAGS} -D__NuttX__")

set(CMAKE_C_STANDARD_INCLUDE_DIRECTORIES ${NUTTX_PATH}/include
                                         ${NUTTX_PATH}/arch/chip)

set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES
    ${NUTTX_PATH}/include/${NUTTX_CXX} ${NUTTX_PATH}/include
    ${NUTTX_PATH}/arch/chip)

# Use only crt0.o, not every .o in startup/
set(STARTUP_OBJ ${NUTTX_PATH}/startup/crt0.o)

add_compile_options(-nostdlib)
add_compile_options(-ffunction-sections -fdata-sections)

# same entry used for all build modes in crt0.c and arch/.../xxx_start.c

set(ENTRY_NAME "__start")

set(CMAKE_C_LINK_EXECUTABLE
    "<CMAKE_LINKER> ${LDFLAGS} --entry=${ENTRY_NAME} -T${LINKER_SCRIPT} <OBJECTS> ${STARTUP_OBJS} -o <TARGET> <LINK_LIBRARIES> -L${NUTTX_PATH}/libs --start-group ${LDLIBS} ${EXTRA_LIBS} --end-group"
)
set(CMAKE_CXX_LINK_EXECUTABLE
    "<CMAKE_LINKER> ${LDFLAGS} --entry=${ENTRY_NAME} -T${LINKER_SCRIPT} <OBJECTS> ${STARTUP_OBJS} -o <TARGET> <LINK_LIBRARIES> -L${NUTTX_PATH}/libs --start-group ${LDLIBS} ${EXTRA_LIBS} --end-group"
)

set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)

relates to this comment #16976 (comment)

@leducp i can confirm it works :) here is the output:

Constructor: mSecret=42
HelloWorld: mSecret=42
TEST=Hello
CHelloWorld: HelloWorld: Hello, world!
Constructor: mSecret=42
HelloWorld: mSecret=42
TEST=Hello
CHelloWorld: HelloWorld: Hello, world!

trns1997 · 2025-09-10T09:00:00Z

Honestly the STARTUP_OBJS does not seem necessary it seems to compile without

leducp · 2025-09-11T06:25:41Z

Honestly the STARTUP_OBJS does not seem necessary it seems to compile without

OK so the exported toolchain was broken as suspected: waiting for #16976 before updating the doc again (and taking into account the comments).

trns1997 · 2025-09-11T18:15:29Z

@leducp cherry-pick this commit plz: trns1997@ecd91aa, i tested this new procedure with these updates and everything works fine :)

trns1997 · 2025-09-14T13:10:30Z

ping @leducp, #16976 has been merged :)

leducp · 2025-09-15T08:42:03Z

@trns1997 Doc updated with tree simplification in mind. I tested on xmc4800-relax on the latest commit (71f5587) and everything run fine: good job!

Use the exported CMake toolchain file instead of a custom and broken one. Slightly modify the C++ example code to introduce modern tools like auto keyword and shared_ptr Signed-off-by: Philippe Leduc <philippe.leduc@mailfence.com>

github-actions Bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium labels Sep 3, 2025

acassis reviewed Sep 3, 2025

View reviewed changes

Comment thread Documentation/guides/cpp_cmake.rst Outdated

Comment thread Documentation/guides/cpp_cmake.rst Outdated

leducp force-pushed the update_cpp_guide branch from e632c1c to a3b1921 Compare September 3, 2025 12:35

trns1997 reviewed Sep 3, 2025

View reviewed changes

Comment thread Documentation/guides/cpp_cmake.rst

trns1997 reviewed Sep 3, 2025

View reviewed changes

Comment thread Documentation/guides/cpp_cmake.rst Outdated

trns1997 reviewed Sep 3, 2025

View reviewed changes

Comment thread Documentation/guides/cpp_cmake.rst Outdated

linguini1 previously approved these changes Sep 4, 2025

View reviewed changes

trns1997 mentioned this pull request Sep 5, 2025

fix missing gnu-elf.ld cp when generating export #16976

Merged

2 tasks

This was referenced Sep 14, 2025

[FEATURE] Add a CI test for out-of-tree builds (e.g. exported package + CMake) to catch regressions early #17016

Closed

add cxx oot build test script to ci #17017

Merged

leducp dismissed linguini1’s stale review via 35ae78e September 15, 2025 08:40

leducp force-pushed the update_cpp_guide branch from a3b1921 to 35ae78e Compare September 15, 2025 08:40

leducp marked this pull request as ready for review September 15, 2025 08:43

leducp requested review from hartmannathan, raiden00pl and xiaoxiang781216 as code owners September 15, 2025 08:43