patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

cmake: modules: extensions: Fix documentation for zephyr_build_string

Browse source 
Fixes a missed entry and a wrong named variable in the
documentation for this function

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
This commit is contained in:
Jamie McCrae 2024-04-11 09:02:46 +01:00 committed by Fabio Baltieri
parent 144a08c58c
commit 43c323a835
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
cmake/modules/extensions.cmake
View file

@ -1532,6 +1532,7 @@ endfunction()
# Usage:
# zephyr_build_string(<out-variable>
# BOARD <board>
# [SHORT <out-variable>]
# [BOARD_QUALIFIERS <qualifiers>]
# [BOARD_REVISION <revision>]
# [BUILD <type>]
@ -1565,7 +1566,7 @@ endfunction()
# `alpha_soc_bar_1_0_0;alpha_soc_bar` in `build_string` parameter.
#
# calling
# zephyr_build_string(build_string SHORTENED short_build_string BOARD alpha BOARD_REVISION 1.0.0 BOARD_QUALIFIERS /soc/bar MERGE)
# zephyr_build_string(build_string SHORT short_build_string BOARD alpha BOARD_REVISION 1.0.0 BOARD_QUALIFIERS /soc/bar MERGE)
# will return two lists of the following strings
# `alpha_soc_bar_1_0_0;alpha_soc_bar` in `build_string` parameter.
# `alpha_bar_1_0_0;alpha_bar` in `short_build_string` parameter.