Skip to content

Commit 5bda9c2

Browse files
nordicjmrlubos
authored andcommitted
doc: nrf: templates: Use FOO for sample Kconfig
Uses a name which is already in the allow list Signed-off-by: Jamie McCrae <[email protected]>
1 parent f2f4509 commit 5bda9c2

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ This can be handled using the following approach:
162162
# This will set a bool Kconfig option in the image (note: sysbuild forces this setting, it cannot be overwritten by changing the application configuration)
163163
set_config_bool(${SB_CONFIG_NETCORE_IMAGE_NAME} CONFIG_MY_CUSTOM_CONFIG y)
164164
# This will set a string (or numeric) Kconfig option in the image (note: sysbuild forces this setting, it cannot be overwritten by changing the application configuration)
165-
set_property(TARGET ${SB_CONFIG_NETCORE_IMAGE_NAME} APPEND_STRING PROPERTY CONFIG "CONFIG_CUSTOM_STRING=my_custom_value\n")
165+
set_property(TARGET ${SB_CONFIG_NETCORE_IMAGE_NAME} APPEND_STRING PROPERTY CONFIG "CONFIG_FOO=my_custom_value\n")
166166
endif()
167167
168168
.. _sysbuild_images_adding_custom_firmware_loader_images:
@@ -223,7 +223,7 @@ This can be handled using the following approach:
223223
# This will set a bool Kconfig option in the image (note: sysbuild forces this setting, it cannot be overwritten by changing the application configuration)
224224
set_config_bool(${SB_CONFIG_FIRMWARE_LOADER_IMAGE_NAME} CONFIG_MY_CUSTOM_CONFIG y)
225225
# This will set a string (or numeric) Kconfig option in the image (note: sysbuild forces this setting, it cannot be overwritten by changing the application configuration)
226-
set_property(TARGET ${SB_CONFIG_FIRMWARE_LOADER_IMAGE_NAME} APPEND_STRING PROPERTY CONFIG "CONFIG_CUSTOM_STRING=my_custom_value\n")
226+
set_property(TARGET ${SB_CONFIG_FIRMWARE_LOADER_IMAGE_NAME} APPEND_STRING PROPERTY CONFIG "CONFIG_FOO=my_custom_value\n")
227227
endif()
228228
229229
.. _sysbuild_images_adding_to_a_single_board:

doc/nrf/templates/application_README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Additional configuration*
128128

129129
.. note::
130130
* Add this section to describe and link to any library configuration options that might be important to run this application.
131-
You can link to options with ``:kconfig:option:`CONFIG_XXX```.
131+
You can link to options with ``:kconfig:option:`CONFIG_FOO```.
132132
* You need not list all possible configuration options, but only the ones that are relevant.
133133

134134
Check and configure the following library options that are used by the application:

doc/nrf/templates/sample_README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Additional configuration*
151151

152152
.. note::
153153
* Add this section to describe and link to any library configuration options that might be important to run this sample.
154-
You can link to options with ``:kconfig:option:`CONFIG_XXX```.
154+
You can link to options with ``:kconfig:option:`CONFIG_FOO```.
155155
* You do not need to list all possible configuration options, but only the ones that are relevant.
156156

157157
Check and configure the following library options that are used by the sample:

include/util/util_macro.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ extern "C" {
8080
*
8181
* Example:
8282
*
83-
* IF_ENABLED_ALL((CONFIG_FLAG_A, CONFIG_FLAG_B), uint32_t foo;)
83+
* IF_ENABLED_ALL((CONFIG_FOO, CONFIG_BAR), uint32_t foo;)
8484
*
85-
* If @p CONFIG_FLAG_A and @p CONFIG_FLAG_B are defined to 1, this expands to:
85+
* If @p CONFIG_FOO and @p CONFIG_BAR are defined to 1, this expands to:
8686
*
8787
* uint32_t foo;
8888
*
@@ -102,9 +102,9 @@ extern "C" {
102102
*
103103
* Example:
104104
*
105-
* IF_ENABLED_ANY((CONFIG_FLAG_A, CONFIG_FLAG_B), uint32_t foo;)
105+
* IF_ENABLED_ANY((CONFIG_FOO, CONFIG_BAR), uint32_t foo;)
106106
*
107-
* If @p CONFIG_FLAG_A or @p CONFIG_FLAG_B defined to 1, this expands to:
107+
* If @p CONFIG_FOO or @p CONFIG_BAR defined to 1, this expands to:
108108
*
109109
* uint32_t foo;
110110
*

0 commit comments

Comments
 (0)