doc: Remove documentation for child/parent image #20005

nordicjm · 2025-01-21T07:55:07Z

Removes documentation for this now removed feature

NordicBuilder · 2025-01-21T07:57:51Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 14

Inputs:

Sources:

sdk-nrf: PR head: 617cd4e0b21135b23d8bedd28b2b06d0b61cc2bd

more details

sdk-nrf:

PR head: 617cd4e0b21135b23d8bedd28b2b06d0b61cc2bd
merge base: 5f6286b9e91b30b5935296782f98a8a076e17c77
target head (main): c57298b43d0b654f3966a1ce2cfac4772859fd2e
Diff

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (78)

applications
│  ├── nrf5340_audio
│  │  ├── tools
│  │  │  ├── buildprog
│  │  │  │  │ program.py
cmake
│  ├── extensions.cmake
│  ├── sysbuild
│  │  │ partition_manager.cmake
doc
│  ├── _utils
│  │  │ redirects.py
│  ├── _zoomin
│  │  │ ncs.tags.yml
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── bootloaders_dfu
│  │  │  │  ├── mcuboot_nsib
│  │  │  │  │  ├── bootloader.rst
│  │  │  │  │  ├── bootloader_adding.rst
│  │  │  │  │  ├── bootloader_config.rst
│  │  │  │  │  ├── bootloader_dfu_image_versions.rst
│  │  │  │  │  ├── bootloader_downgrade_protection.rst
│  │  │  │  │  ├── bootloader_mcuboot_nsib.rst
│  │  │  │  │  ├── bootloader_partitioning.rst
│  │  │  │  │  │ bootloader_signature_keys.rst
│  │  │  ├── companion_components.rst
│  │  │  ├── config_and_build
│  │  │  │  ├── config_and_build_system.rst
│  │  │  │  ├── index.rst
│  │  │  │  │ multi_image.rst
│  │  │  ├── device_guides
│  │  │  │  ├── fem
│  │  │  │  │  │ fem_simple_gpio.rst
│  │  │  │  ├── nrf52
│  │  │  │  │  │ fota_update.rst
│  │  │  │  ├── nrf53
│  │  │  │  │  ├── building_nrf53.rst
│  │  │  │  │  ├── features_nrf53.rst
│  │  │  │  │  ├── fota_update_nrf5340.rst
│  │  │  │  │  ├── index.rst
│  │  │  │  │  ├── multi_image_nrf5340.rst
│  │  │  │  │  │ simultaneous_multi_image_dfu_nrf5340.rst
│  │  │  │  ├── nrf54h
│  │  │  │  │  │ ug_nrf54h20_configuration.rst
│  │  │  │  ├── nrf91
│  │  │  │  │  │ nrf91_features.rst
│  │  │  │  ├── thingy53
│  │  │  │  │  ├── building_thingy53.rst
│  │  │  │  │  │ thingy53_application_guide.rst
│  │  │  │  │ wifi_coex.rst
│  │  ├── includes
│  │  │  │ hci_ipc_overlay.txt
│  │  ├── libraries
│  │  │  ├── bluetooth
│  │  │  │  │ rpc.rst
│  │  │  ├── dfu
│  │  │  │  ├── dfu_multi_image.rst
│  │  │  │  │ pcd.rst
│  │  ├── protocols
│  │  │  ├── matter
│  │  │  │  ├── end_product
│  │  │  │  │  │ bootloader.rst
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  ├── migration_guide_2.7.rst
│  │  │  │  ├── migration_sysbuild.rst
│  │  │  │  ├── nRF54H20_migration_2.7
│  │  │  │  │  ├── migration_guide_2.4.99-cs3_to_2.7_application.rst
│  │  │  │  │  │ migration_guide_2.6.99-cs2_to_2.7_application.rst
│  │  │  ├── releases
│  │  │  │  ├── release-notes-1.0.0.rst
│  │  │  │  ├── release-notes-1.2.0.rst
│  │  │  │  ├── release-notes-1.3.0.rst
│  │  │  │  ├── release-notes-1.4.0.rst
│  │  │  │  ├── release-notes-1.6.0.rst
│  │  │  │  ├── release-notes-1.7.0.rst
│  │  │  │  ├── release-notes-2.7.0.rst
│  │  │  │  │ release-notes-changelog.rst
│  │  ├── security
│  │  │  │ tfm.rst
│  │  ├── shortcuts.txt
│  │  ├── test_and_optimize
│  │  │  ├── optimizing
│  │  │  │  │ power_general.rst
modules
│  ├── mcuboot
│  │  ├── boot
│  │  │  ├── zephyr
│  │  │  │  │ Kconfig
samples
│  ├── Kconfig
│  ├── bluetooth
│  │  ├── central_hr_coded
│  │  │  │ README.rst
│  │  ├── direct_test_mode
│  │  │  │ README.rst
│  │  ├── direction_finding_central
│  │  │  │ README.rst
│  │  ├── fast_pair
│  │  │  ├── input_device
│  │  │  │  │ README.rst
│  │  ├── iso_combined_bis_and_cis
│  │  │  │ README.rst
│  │  ├── peripheral_hids_keyboard
│  │  │  │ README.rst
│  │  ├── peripheral_hids_mouse
│  │  │  │ README.rst
│  │  ├── peripheral_hr_coded
│  │  │  │ README.rst
│  │  ├── peripheral_mds
│  │  │  │ README.rst
│  │  ├── peripheral_power_profiling
│  │  │  │ README.rst
│  │  ├── throughput
│  │  │  │ README.rst
│  ├── bootloader
│  │  │ README.rst
│  ├── cellular
│  │  ├── smp_svr
│  │  │  │ README.rst
│  ├── common
│  │  ├── mcumgr_bt_ota_dfu
│  │  │  │ Kconfig
│  ├── net
│  │  ├── aws_iot
│  │  │  │ README.rst
│  ├── nrf5340
│  │  ├── empty_net_core
│  │  │  │ README.rst
│  │  ├── netboot
│  │  │  │ README.rst
│  ├── tfm
│  │  ├── provisioning_image
│  │  │  │ README.rst
│  │  ├── provisioning_image_net_core
│  │  │  │ README.rst
│  ├── zigbee
│  │  ├── ncp
│  │  │  │ README.rst
scripts
│  ├── partition_manager
│  │  │ partition_manager.rst
│  │ partition_manager_output.py
subsys
│  ├── partition_manager
│  │  │ Kconfig
tests
│  ├── benchmarks
│  │  ├── multicore
│  │  │  ├── idle
│  │  │  │  │ README.rst
│  │  │  ├── idle_gpio
│  │  │  │  │ README.rst
│  ├── modules
│  │  ├── mcuboot
│  │  │  ├── external_flash
│  │  │  │  ├── sysbuild
│  │  │  │  │  ├── mcuboot
│  │  │  │  │  │  │ prj.conf

Outputs:

Toolchain

Version: 342151af73
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:342151af73_912848a074

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain - Skipped: existing toolchain is used
✅ Build twister
✅ Integration tests
- ✅ test-sdk-audio
- ✅ desktop52_verification
- ✅ test-fw-nrfconnect-boot
- ✅ test-fw-nrfconnect-apps
- ✅ test_ble_nrf_config
- ✅ test-fw-nrfconnect-ble_mesh
- ✅ test-fw-nrfconnect-ble_samples
- ✅ test-fw-nrfconnect-chip
- ✅ test-fw-nrfconnect-nfc
- ✅ test-fw-nrfconnect-nrf-iot_serial_lte_modem
- ✅ test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
- ✅ test-fw-nrfconnect-nrf-iot_samples
- ✅ test-fw-nrfconnect-nrf-iot_lwm2m
- ✅ doc-internal
- ✅ test-fw-nrfconnect-nrf-iot_thingy91
- ✅ test-fw-nrfconnect-nrf_crypto
- ✅ test-fw-nrfconnect-rpc
- ✅ test-fw-nrfconnect-rs
- ✅ test-fw-nrfconnect-fem
- ✅ test-fw-nrfconnect-tfm
- ✅ test-fw-nrfconnect-thread
- ✅ test-fw-nrfconnect-zigbee
- ✅ test-sdk-find-my
- ✅ test-fw-nrfconnect-nrf-iot_mosh
- ✅ test-fw-nrfconnect-nrf-iot_positioning
- ✅ test-sdk-sidewalk
- ✅ test-sdk-wifi
- ✅ test-low-level
- ✅ test-sdk-pmic-samples
- ✅ test-sdk-mcuboot
- ✅ test-sdk-dfu
- ✅ test-fw-nrfconnect-ps
- ✅ test-secdom-samples-public
- ⚠️ test-fw-nrfconnect-fw-update
- ⚠️ test-fw-nrfconnect-nrf-iot_cloud

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2025-01-21T13:08:17Z

You can find the documentation preview for this PR at this link.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

nordicjm · 2025-01-21T13:48:07Z

@kylebonnici @bencefr samples/bootloader/README.rst - this has a whole section on vscode for settings Kconfigs but this applies to child/parent images only, can you provide updated text for what to put for enabling the settings with sysbuild?

@trantanen @eivindj-nordic @plskeggs in samples/cellular/smp_svr/README.rst - this refers to child image overlay files that do not exist in the sysbuild folder, can you check if these should exist and if so, open a PR adding them?

nordicjm · 2025-01-24T07:43:14Z

@nrfconnect/ncs-audio @nrfconnect/ncs-co-build-system @nrfconnect/ncs-pluto @nrfconnect/ncs-doc-leads @nrfconnect/ncs-cia-doc @nrfconnect/ncs-aurora-doc @nrfconnect/ncs-dragoon-doc @nrfconnect/ncs-modem-doc @FrancescoSer @greg-fer please review

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

doc/_zoomin/ncs.tags.yml

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

doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst

doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst

doc/nrf/releases_and_maturity/releases/release-notes-1.4.0.rst

doc/nrf/releases_and_maturity/releases/release-notes-2.7.0.rst

umapraseeda · 2025-01-24T09:52:28Z

samples/nrf5340/netboot/README.rst

@@ -70,11 +69,10 @@ Building and running

 This sample can be found under :file:`samples/nrf5340/netboot/` in the |NCS| folder structure.

-Follow the steps below to include the sample as a child image in a :ref:`multi-image <ug_multi_image>` build that contains a network core application:
+Complete the following steps to include the sample as an image in a sysbuild project that contains a network core application:


Since there is only one step now, can it be rephrased like this:
To include the sample as an image in a sysbuild project that contains a network core application, add MCUboot to the build by enabling the ``SB_CONFIG_BOOTLOADER_MCUBOOT``, ``SB_CONFIG_SECURE_BOOT_NETCORE``, and ``SB_CONFIG_NETCORE_APP_UPDATE`` sysbuild Kconfig options in the project. The build system includes the sample in the build automatically.

Have reworded slightly

subsys/partition_manager/Kconfig

doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

samples/nrf5340/netboot/README.rst

doc/_utils/redirects.py

doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst

doc/_utils/redirects.py

Removes documentation for this now removed feature Signed-off-by: Jamie McCrae <[email protected]>

Adds a note about the feature being removed Signed-off-by: Jamie McCrae <[email protected]>

nordicjm · 2025-01-27T09:14:31Z

Please fix this one - A new entry - ("app_dev/config_and_build/multi_image", "app_dev/config_and_build/sysbuild/index"),

Fixed

koffes

Good for Audio

greg-fer

Approving for the doc files for which I'm listed as code-owner.

nordicjm · 2025-01-30T09:55:04Z

Ping @tejlmand @nrfconnect/ncs-dragoon-doc @nrfconnect/ncs-pluto

tejlmand

lgtm.

tejlmand · 2025-01-31T08:35:11Z

cmake/sysbuild/partition_manager.cmake

 get_property(PM_IMAGES GLOBAL PROPERTY PM_IMAGES)
 get_property(PM_SUBSYS_PREPROCESSED GLOBAL PROPERTY PM_SUBSYS_PREPROCESSED)

 # This file is executed once per domain.
 #
 # It will be executed if one of the following criteria is true for the
 # current image:
-# - It's a child image, and is the dynamic partition in the domain
+# - It's a secondary image, and is the dynamic partition in the domain


minor nit.
I don't think we have introduced any concepts of primary or secondary images, but atm I have no better proposal and as this is a code comment, then it can stay.

Just wanted to mention.

sub-image mayby? sub-domain?

nordicjm added the doc only label Jan 21, 2025

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 21, 2025

nordicjm force-pushed the byebyechildparent_doc branch 3 times, most recently from 21fd2a9 to 9ba8d6e Compare January 21, 2025 12:48

nordicjm marked this pull request as ready for review January 21, 2025 13:48

nordicjm requested review from a team and FrancescoSer as code owners January 21, 2025 13:48

nordicjm requested a review from umapraseeda January 21, 2025 13:48

nordicjm force-pushed the byebyechildparent_doc branch from a862b6e to 7edcf02 Compare January 23, 2025 14:00

nordicjm requested a review from peknis January 23, 2025 14:03

peknis approved these changes Jan 23, 2025

View reviewed changes

annwoj approved these changes Jan 23, 2025

View reviewed changes

plskeggs approved these changes Jan 24, 2025

View reviewed changes

umapraseeda reviewed Jan 24, 2025

View reviewed changes

nordicjm force-pushed the byebyechildparent_doc branch from 7edcf02 to 71ae9b8 Compare January 24, 2025 10:58

nordicjm requested a review from umapraseeda January 24, 2025 10:59

divipillai reviewed Jan 24, 2025

View reviewed changes

nordicjm force-pushed the byebyechildparent_doc branch from 71ae9b8 to 631e85f Compare January 24, 2025 12:06

nordicjm requested a review from divipillai January 24, 2025 12:06

nordicjm force-pushed the byebyechildparent_doc branch from 631e85f to 44188c1 Compare January 24, 2025 12:13

divipillai reviewed Jan 24, 2025

View reviewed changes

doc/_utils/redirects.py Show resolved Hide resolved

doc/_utils/redirects.py Show resolved Hide resolved

doc/_utils/redirects.py Show resolved Hide resolved

doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst Outdated Show resolved Hide resolved

nordicjm force-pushed the byebyechildparent_doc branch from 44188c1 to 1319182 Compare January 27, 2025 08:41

nordicjm requested a review from divipillai January 27, 2025 08:41

divipillai approved these changes Jan 27, 2025

View reviewed changes

doc/_utils/redirects.py Show resolved Hide resolved

nordicjm added 2 commits January 27, 2025 09:14

doc: Remove documentation for child/parent image

3371d72

Removes documentation for this now removed feature Signed-off-by: Jamie McCrae <[email protected]>

doc: release: changelog: Add note on removal of child/parent image

617cd4e

Adds a note about the feature being removed Signed-off-by: Jamie McCrae <[email protected]>

nordicjm force-pushed the byebyechildparent_doc branch from 1319182 to 617cd4e Compare January 27, 2025 09:14

koffes approved these changes Jan 27, 2025

View reviewed changes

umapraseeda approved these changes Jan 27, 2025

View reviewed changes

greg-fer approved these changes Jan 28, 2025

View reviewed changes

FrancescoSer approved these changes Jan 28, 2025

View reviewed changes

tejlmand approved these changes Jan 31, 2025

View reviewed changes

nvlsianpu approved these changes Jan 31, 2025

View reviewed changes

richabp approved these changes Jan 31, 2025

View reviewed changes

nordicjm merged commit 4da9997 into nrfconnect:main Jan 31, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Remove documentation for child/parent image #20005

doc: Remove documentation for child/parent image #20005

nordicjm commented Jan 21, 2025

NordicBuilder commented Jan 21, 2025 •

edited

Loading

NordicBuilder commented Jan 21, 2025

nordicjm commented Jan 21, 2025

nordicjm commented Jan 24, 2025

umapraseeda Jan 24, 2025

nordicjm Jan 24, 2025

nordicjm commented Jan 27, 2025

koffes left a comment

greg-fer left a comment

nordicjm commented Jan 30, 2025

tejlmand left a comment

tejlmand Jan 31, 2025

nvlsianpu Jan 31, 2025

doc: Remove documentation for child/parent image #20005

doc: Remove documentation for child/parent image #20005

Conversation

nordicjm commented Jan 21, 2025

NordicBuilder commented Jan 21, 2025 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

NordicBuilder commented Jan 21, 2025

nordicjm commented Jan 21, 2025

nordicjm commented Jan 24, 2025

umapraseeda Jan 24, 2025

Choose a reason for hiding this comment

nordicjm Jan 24, 2025

Choose a reason for hiding this comment

nordicjm commented Jan 27, 2025

koffes left a comment

Choose a reason for hiding this comment

greg-fer left a comment

Choose a reason for hiding this comment

nordicjm commented Jan 30, 2025

tejlmand left a comment

Choose a reason for hiding this comment

tejlmand Jan 31, 2025

Choose a reason for hiding this comment

nvlsianpu Jan 31, 2025

Choose a reason for hiding this comment

NordicBuilder commented Jan 21, 2025 •

edited

Loading