Skip to content

Commit e24e07c

Browse files
greg-fernordicjm
authored andcommitted
doc: mcuboot: fix outdated links + multi-image
Edited the readme-ncs.rst file and links.txt in MCUboot module docs to update the old links and remove info about multi-image support. Also updated the note about direct-xip mode. NCSDK-31689 and PRs #20005 and #20153. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 8ee9316 commit e24e07c

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

doc/mcuboot/links.txt

+12-17
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. ### This page lists links used in the nrfxlib docs.
1+
.. ### This page lists links used in the mcuboot wrapper docs.
22
Links are grouped by source URL if three or more have the same source URL.
33
Otherwise, they are placed in "Source: other".
44
Links not separated by blank line are related to one another.
@@ -7,26 +7,21 @@
77

88
.. _`sdk-nrf`: https://github.com/nrfconnect/sdk-nrf
99

10-
.. ### Source: infocenter.nordicsemi.com
11-
12-
.. _`Infocenter`: https://infocenter.nordicsemi.com/index.jsp
13-
1410
.. ### Source: www.nordicsemi.com
1511

1612
.. _`Nordic Semiconductor`: https://www.nordicsemi.com/
1713

18-
.. ### Source: https://developer.nordicsemi.com/
19-
20-
.. _`Immutable first-stage bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html#immutable-bootloader
21-
.. _`Second-stage upgradable bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html#upgradable-bootloader
22-
.. _`Secure bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html
23-
.. _`Adding a bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_adding.html
24-
.. _`Testing the bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_testing.html
25-
.. _`Using external memory partitions`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_external_flash.html
26-
.. _`Customizing the bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_config.html
27-
.. _`Signature keys`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_signature_keys.html
28-
.. _`Multi-image builds`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/multi_image.html
29-
.. _`MCUboot output build files`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/output_build_files.html#mcuboot-output-build-files
14+
.. ### Source: https://docs.nordicsemi.com/
15+
16+
.. _`Immutable first-stage bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html#immutable-bootloader
17+
.. _`Second-stage upgradable bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html#upgradable-bootloader
18+
.. _`Secure bootloader chain`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html
19+
.. _`Enabling a bootloader chain using sysbuild`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_adding_sysbuild.html
20+
.. _`MCUboot and NSIB`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_mcuboot_nsib.html
21+
.. _`Partitioning device memory`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_partitioning.html
22+
.. _`Customizing the bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_config.html
23+
.. _`Signature keys`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/config_and_build/bootloaders/bootloader_signature_keys.html
24+
.. _`MCUboot output build files`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/output_build_files.html#mcuboot-output-build-files
3025

3126
.. ### Source: other
3227

doc/mcuboot/readme-ncs.rst

+5-7
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,17 @@ You can use MCUboot in the |NCS| in one of the following roles:
1515
See the following user guides for more information on adding, configuring, and testing MCUboot for your application build in the |NCS|:
1616

1717
* `Secure bootloader chain`_
18-
* `Adding a bootloader chain`_
19-
* `Testing the bootloader chain`_
20-
* `Using external memory partitions`_
18+
* `Enabling a bootloader chain using sysbuild`_
19+
* `MCUboot and NSIB`_
20+
* `Partitioning device memory`_
2121
* `Customizing the bootloader`_
2222
* `Signature keys`_
2323

2424
When you add MCUboot to your application build, the files that can be used for firmware over-the-air (FOTA) upgrades are automatically generated.
2525
See the `MCUboot output build files`_ page for a list of all these files.
2626

27-
See the `Multi-image builds`_ page for more information on image files in multi-image builds.
28-
2927
.. note::
3028
When you use MCUboot in the direct-xip mode, enable the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option to let the build system generate an additional set of files for the second application slot.
31-
These ``.hex`` files are identical to the ones listed above, but their names also use the ``mcuboot_secondary_`` prefix.
32-
For example, :file:`mcuboot_secondary_app_signed.hex` is created and placed in the second slot on the target device when the :file:`app_signed.hex` file is placed in the first slot.
29+
These files are identical to the ones listed on the `MCUboot output build files`_ page, but they are placed in the :file:`mcuboot_secondary_app` folder.
30+
For example, :file:`mcuboot_secondary_app/zephyr/zephyr.signed.bin` is created and placed in the second slot on the target device when the :file:`zephyr.signed.bin` file is placed in the first slot.
3331
For more information about the direct-xip mode, see the *Equal slots (direct-xip)* section in the :doc:`Bootloader documentation <design>`.

0 commit comments

Comments
 (0)