Skip to content

Commit 9e9c5db

Browse files
nordicjmrlubos
authored andcommitted
samples/doc: Fix some undefined Kconfig references
Fixes some instances of this Signed-off-by: Jamie McCrae <[email protected]>
1 parent dec5999 commit 9e9c5db

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_main_config.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,13 +146,13 @@ However, you can customize it to meet specific requirements.
146146
- **MCUboot Kconfig option**
147147
- **Comments**
148148
* - SHA-256
149-
- ``CONFIG_BOOT_HASH_ALG_SHA256``
149+
- ``CONFIG_BOOT_IMG_HASH_ALG_SHA256``
150150
- The default hash. Compatible with all pre-hash signature types.
151151
* - SHA-384
152-
- ``CONFIG_BOOT_HASH_ALG_SHA384``
152+
- ``CONFIG_BOOT_IMG_HASH_ALG_SHA384``
153153
- Currently not utilized by |NCS|.
154154
* - SHA-512
155-
- ``CONFIG_BOOT_HASH_ALG_SHA512``
155+
- ``CONFIG_BOOT_IMG_HASH_ALG_SHA512``
156156
- Restricted to use with Ed25519 signatures.
157157

158158
MCUboot recovery protocol

doc/nrf/app_dev/device_guides/nrf70/nrf70_fw_patch_update.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This guide explains the available option for updating the nRF70 Series firmware
1313
External memory refers to the memory that is outside the System-on-Chip (SoC), for example, an external flash memory chip, or an external nonvolatile memory (NVM) chip.
1414

1515
.. note::
16-
Currently, you cannot build an example with the both ``SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE`` and :kconfig:option:`CONFIG_XIP_SPLIT_IMAGE` Kconfig options enabled.
17-
To enable XIP support use the ``SB_CONFIG_WIFI_PATCHES_EXT_FLASH_XIP`` Kconfig option instead of the ``SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE`` Kconfig option.
16+
Currently, you cannot build an example with the both :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE` and :kconfig:option:`SB_CONFIG_QSPI_XIP_SPLIT_IMAGE` Kconfig options enabled.
17+
To enable XIP support use the :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_XIP` Kconfig option instead of the :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE` Kconfig option.
1818

1919
Overview
2020
========
@@ -35,7 +35,7 @@ To use this feature, ensure that the following prerequisites are met:
3535
* The external memory has sufficient capacity to accommodate the firmware patches.
3636
This includes additional space for potential patch upgrades, such as those required for DFU.
3737
The combined size of all firmware patches should not exceed 128 kB.
38-
* MCUboot is enabled, and the ``SB_CONFIG_BOOTLOADER_MCUBOOT`` Kconfig option is set to ``y``.
38+
* MCUboot is enabled, and the :kconfig:option:`SB_CONFIG_BOOTLOADER_MCUBOOT` Kconfig option is set to ``y``.
3939

4040
Supported platforms
4141
===================
@@ -236,7 +236,7 @@ To enable the DFU procedure for the nRF70 Series firmware patch, complete the fo
236236
237237
-- -Dshell_SNIPPET=nrf70-fw-patch-ext-flash -DSB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE=y -DCONFIG_NRF_WIFI_FW_PATCH_DFU=y
238238
239-
If you want to use the :ref:`sysbuild_images` feature, you need to set the ``SB_CONFIG_DFU_MULTI_IMAGE_PACKAGE_WIFI_FW_PATCH`` Kconfig option to ``y``, and must also set the :kconfig:option:`CONFIG_DFU_MULTI_IMAGE_MAX_IMAGE_COUNT` Kconfig option to one of the following values:
239+
If you want to use the :ref:`sysbuild_images` feature, you need to set the :kconfig:option:`SB_CONFIG_DFU_MULTI_IMAGE_PACKAGE_WIFI_FW_PATCH` Kconfig option to ``y``, and must also set the :kconfig:option:`CONFIG_DFU_MULTI_IMAGE_MAX_IMAGE_COUNT` Kconfig option to one of the following values:
240240

241241
* For the nRF5340 DK and nRF7002 DK without the network core: ``2``
242242
* For the nRF5340 DK and nRF7002 DK with the network core: ``3``

samples/bootloader/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Pre-signed variants
119119

120120
When two slots are present, two images must be built.
121121
One that is executable from slot 0, and the other one from slot 1.
122-
Building the image for slot 1 is done by enabling the :kconfig:option:`CONFIG_BUILD_S1_VARIANT` option.
122+
Building the image for slot 1 is done by enabling the :kconfig:option:`SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE` option.
123123

124124
When the image for the next stage in the boot chain is upgraded, the new image is written to the slot with the oldest image version.
125125
See :ref:`bootloader_monotonic_counter` for more information about versioning.
@@ -171,7 +171,7 @@ Building and running
171171
While it is technically possible to build the NSIB by itself and merge it into other application images, this process is not supported.
172172
To reduce the development time and potential issues with this route, let the existing |NCS| infrastructure for sysbuild handle the integration.
173173

174-
The NSIB is automatically added as an image when the ``SB_CONFIG_SECURE_BOOT_APPCORE`` sysbuild Kconfig option is set.
174+
The NSIB is automatically added as an image when the :kconfig:option:`SB_CONFIG_SECURE_BOOT_APPCORE` sysbuild Kconfig option is set.
175175

176176
For building and running the NSIB with an application, see :ref:`ug_bootloader_adding_sysbuild_immutable`.
177177

samples/nrf5340/extxip_smp_svr/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For more information about MCUmgr and SMP, see :ref:`device_mgmt`.
2929

3030
The sample enables the splitting by:
3131

32-
* Enabling the split XIP image feature through the :kconfig:option:`CONFIG_XIP_SPLIT_IMAGE` Kconfig option.
32+
* Enabling the split XIP image feature through the :kconfig:option:`SB_CONFIG_XIP_SPLIT_IMAGE` sysbuild Kconfig option.
3333
This Kconfig option sets a build-system level support for image division and adapts the image-signing support for MCUboot.
3434
* Using the project's CMake file which describes relocation of certain libraries or objects to an external XIP area.
3535
* Using a linker script that describes the external QSPI area.

0 commit comments

Comments
 (0)