Skip to content

Commit d20daf9

Browse files
tejlmandstephanosio
authored andcommitted
cmake: improve text description on minimum compatible versions
During review of zephyrproject-rtos/zephyr#53833 it became clear that existing description regarding minimum compatible version was unclear. Also the variable name `ZEPHYR_MINIMUM_COMPATIBLE_VERSION` could be mistaken for referring to Zephyr itself, and not the Zephyr SDK. Improve the description to be more precise that we are referring to Zephyr SDK versions. Update `ZEPHYR_MINIMUM_COMPATIBLE_VERSION` to `ZEPHYR_SDK_MINIMUM_COMPATIBLE_VERSION`. Signed-off-by: Torsten Rasmussen <[email protected]>
1 parent 0bc76f4 commit d20daf9

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

cmake/Zephyr-sdkConfigVersion.cmake

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,15 @@ else()
1414
# Currently, this Zephyr SDK is expected to work with any Zephyr project
1515
# requiring this version or any older version.
1616
#
17-
# In case this version is no longer backward compatible then this is the place
18-
# to test, for example as
19-
# set(ZEPHYR_MINIMUM_COMPATIBLE_VERSION 0.11)
20-
# if(PACKAGE_FIND_VERSION VERSION_LESS ZEPHYR_MINIMUM_COMPATIBLE_VERSION)
17+
# In case this version of Zephyr SDK is no longer backwards compatible with
18+
# previous versions of Zephyr SDK, this is the place to test if the caller
19+
# requested an older (incompatible) revision.
20+
# For example, imagine caller requests Zephyr SDK v0.10, and this Zephyr SDK
21+
# is revision v0.11, then the below snippet can be activated to ensure that
22+
# this Zephyr SDK (v0.11) is marked as not compatible if caller requested an
23+
# older version, like v0.10
24+
# set(ZEPHYR_SDK_MINIMUM_COMPATIBLE_VERSION 0.11)
25+
# if(PACKAGE_FIND_VERSION VERSION_LESS ZEPHYR_SDK_MINIMUM_COMPATIBLE_VERSION)
2126
# set(PACKAGE_VERSION_COMPATIBLE FALSE)
2227
# return()
2328
# endif()

0 commit comments

Comments
 (0)