OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/cmake/app/boilerplate.cmake

26 lines
919 B
CMake
Raw Normal View History

license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 21:08:09 +08:00
# SPDX-License-Identifier: Apache-2.0
cmake: Zephyr CMake package and CMake modules Create a cmake/modules folder containing all Zephyr CMake modules. All Zephyr cmake files that are included from boilerplate are now converted into CMake modules which can be individually loaded. The Zephyr CMake package is updated to support loading of individual CMake modules using the COMPONENTS argument to `find_package(Zephyr)`. If the COMPONENTS argument is not specified, the default Zephyr build system will load. If COMPONENTS is specified then, only those components and the dependencies will be loaded. If a Zephyr CMake module depends on another CMake module which has not been loaded, it will automatically be loaded. This allows us to modularize and reuse individual parts of the Zephyr CMake build system in a more flexible way in future. Such usage could be: - Higher livel multi image build system - Invocation of individual components, for example dts processing by twister without loading all build code - Doc build - Unittesting With this new CMake package and CMake module scheme then direct sourcing of boilerplate.cmake has been deprecated. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-17 00:13:54 +08:00
######################################
# The use of this file is deprecated #
######################################
# To build a Zephyr application it must start with one of those lines:
doc: Update documentation to describe use of find_package(Zephyr) This commit changes the current boilerplate include description and instead describes the use of find_package(Zephyr) It also add a section covering additional possibilities when using find_package(Zephyr). - Search order - Zephyr repository application description - Zephyr workspace application description - Zephyr freestanding application description - Environment ZEPHYR_BASE setting - Multiple Zephyr and preference setting Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-03-13 06:34:12 +08:00
#
# find_package(Zephyr)
cmake: make find_package(ZephyrUnittest...) REQUIRED This commit is a followup to PR #25808 which updates the tests to ensure the REQUIRED keyword is also used for the ZephyrUnitest package. This provides a better error message when building with CMake and forgetting ZEPHYR_BASE or not registering Zephyr in the CMake package registry. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-05-30 04:17:26 +08:00
# find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
doc: Update documentation to describe use of find_package(Zephyr) This commit changes the current boilerplate include description and instead describes the use of find_package(Zephyr) It also add a section covering additional possibilities when using find_package(Zephyr). - Search order - Zephyr repository application description - Zephyr workspace application description - Zephyr freestanding application description - Environment ZEPHYR_BASE setting - Multiple Zephyr and preference setting Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-03-13 06:34:12 +08:00
#
cmake: make find_package(ZephyrUnittest...) REQUIRED This commit is a followup to PR #25808 which updates the tests to ensure the REQUIRED keyword is also used for the ZephyrUnitest package. This provides a better error message when building with CMake and forgetting ZEPHYR_BASE or not registering Zephyr in the CMake package registry. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-05-30 04:17:26 +08:00
# The `REQUIRED HINTS $ENV{ZEPHYR_BASE}` variant is required for any application
# inside the Zephyr repository.
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 21:43:34 +08:00
#
cmake: Zephyr CMake package and CMake modules Create a cmake/modules folder containing all Zephyr CMake modules. All Zephyr cmake files that are included from boilerplate are now converted into CMake modules which can be individually loaded. The Zephyr CMake package is updated to support loading of individual CMake modules using the COMPONENTS argument to `find_package(Zephyr)`. If the COMPONENTS argument is not specified, the default Zephyr build system will load. If COMPONENTS is specified then, only those components and the dependencies will be loaded. If a Zephyr CMake module depends on another CMake module which has not been loaded, it will automatically be loaded. This allows us to modularize and reuse individual parts of the Zephyr CMake build system in a more flexible way in future. Such usage could be: - Higher livel multi image build system - Invocation of individual components, for example dts processing by twister without loading all build code - Doc build - Unittesting With this new CMake package and CMake module scheme then direct sourcing of boilerplate.cmake has been deprecated. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-17 00:13:54 +08:00
# Loading of this file directly is deprecated and only kept for backward compatibility.
cmake: Fix python version detection The 'FindPythonInterp' that is distributed with CMake 3.8 is affected by bug: https://github.com/zephyrproject-rtos/zephyr/issues/11103 To work around this, until we upgrade to 3.13, we copy and patch the 3.8 version of 'FindPythonInterp' into the Zephyr repository. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2018-11-12 22:57:19 +08:00
cmake: function to update Zephyr_DIR when loading old Zephyr packages Fixes: #43094 This commit introduces a function which updates Zephyr_DIR to point to the directory of the Zephyr package being loaded. For Zephyr 3.0 and earlier, the Zephyr_DIR might in some cases be `Zephyr_DIR-NOTFOUND` or pointing to the Zephyr package including the boilerplate code instead of the Zephyr package of the included boilerplate code. This code ensures that when a package is loaded then Zephyr_DIR will point correctly. This ensures that when Zephyr releases <=3.0 is loaded, then Zephyr_DIR will point correctly, see more in #43094. Old style Zephyr package will in some cases load boilerplate.cmake directly so to ensure proper behavior, restrict boilerplate uses of `find_package(Zephyr)` to not use default search path, but allow only the current Zephyr. Of the same reason, only print warning if Zephyr_DIR is not defined as this indicates old style inclusion. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-03-01 17:32:23 +08:00
if(NOT DEFINED Zephyr_DIR)
# When `find_package(Zephyr)` is used then `Zephyr_DIR` is defined, else
# old style inclusion is used. Warning is only printed in first invocation.
message(WARNING "Loading of Zephyr boilerplate.cmake directly is deprecated, "
"please use 'find_package(Zephyr)'"
)
endif()
find_package(Zephyr REQUIRED PATHS ${CMAKE_CURRENT_LIST_DIR}/../.. NO_DEFAULT_PATH)