From 4ab9ae2d68ff340a69da5b4cf4bedd9236c57662 Mon Sep 17 00:00:00 2001 From: Jeremiah McCarthy Date: Thu, 11 Aug 2022 15:05:55 -0400 Subject: [PATCH 1/2] Improve cmake doc --- doc/tutorials/build_system/cmakelists.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/tutorials/build_system/cmakelists.rst b/doc/tutorials/build_system/cmakelists.rst index 8dab7016c..fe68a9156 100644 --- a/doc/tutorials/build_system/cmakelists.rst +++ b/doc/tutorials/build_system/cmakelists.rst @@ -1,11 +1,18 @@ ###################### -Example CMakeLists.txt +Example CMakeLists.txt ###################### .. note:: CMake is powerful tool that provides the developer a great deal of flexibility in how their projects are built. As a result, CMakeLists.txt files in the example applications may vary from the examples below. This example can be used as a starting point for your bare-metal application. Or, you may choose to copy a ``CMakeLists.txt`` from one of the applications in the SDK that closely resembles your application. + +This repository supports being added as a CMake subproject. A parent CMake project can use add_subdirectory() to include the xcore_sdk as a subproject. + +.. note:: + + The xcore_sdk subproject should be added before declaring application targets, as some xcore_sdk provided macros may be needed. Addtionally, when included as a subproject, xcore_sdk examples targets are not added to the CMake build. + ********** Bare-Metal ********** @@ -133,4 +140,4 @@ Below is an example ``CMakeLists.txt`` that shows both required and conventional ## Optionally create run and debug targets create_run_target(my_app) - create_debug_target(my_app) \ No newline at end of file + create_debug_target(my_app) From 619b4a3b49fb6d26a74a1c4e9938440bc1f6d813 Mon Sep 17 00:00:00 2001 From: Jeremiah McCarthy Date: Thu, 11 Aug 2022 15:13:57 -0400 Subject: [PATCH 2/2] Fix typo --- doc/tutorials/build_system/cmakelists.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/tutorials/build_system/cmakelists.rst b/doc/tutorials/build_system/cmakelists.rst index fe68a9156..23ad0f6f9 100644 --- a/doc/tutorials/build_system/cmakelists.rst +++ b/doc/tutorials/build_system/cmakelists.rst @@ -11,7 +11,7 @@ This repository supports being added as a CMake subproject. A parent CMake proje .. note:: - The xcore_sdk subproject should be added before declaring application targets, as some xcore_sdk provided macros may be needed. Addtionally, when included as a subproject, xcore_sdk examples targets are not added to the CMake build. + The xcore_sdk subproject should be added before declaring application targets, as some xcore_sdk provided macros may be needed. Additionally, when included as a subproject, xcore_sdk examples targets are not added to the CMake build. ********** Bare-Metal