Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix output build file names #20153

Merged

Conversation

b-gent
Copy link
Contributor

@b-gent b-gent commented Jan 31, 2025

Correct the names according to NCSDK-30871.

@b-gent b-gent requested review from a team as code owners January 31, 2025 15:16
@github-actions 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 31, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 31, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 4

Inputs:

Sources:

sdk-nrf: PR head: d2c85b90eb8dc3b81ad49de3756ce2f0b07e6379

more details

sdk-nrf:

PR head: d2c85b90eb8dc3b81ad49de3756ce2f0b07e6379
merge base: 72a34fe06d2b3fcf272e6297dfa5b37de3919e76
target head (main): 9c8e93ff72a12f92e5ed0958e969e39efa27d4ef
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 (1)
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── config_and_build
│  │  │  │  │ output_build_files.rst

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-proprietary_esb
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

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

@b-gent b-gent force-pushed the NCSDK-30871_fix_output_build_file_names branch from 786622c to deed120 Compare January 31, 2025 15:39
@NordicBuilder
Copy link
Contributor

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

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

Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think mcuboot/readme-ncs.rst also requires a second look. I will push a separate commit and PR.

greg-fer added a commit to greg-fer/fw-nrfconnect-nrf-1 that referenced this pull request Feb 6, 2025
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 nrfconnect#20005 and nrfconnect#20153.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As pointed out by @nordicjm in #20226

| :file:`mcuboot_secondary_app` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |
| | ``zephyr`` is the value of :kconfig:option:`CONFIG_KERNEL_BIN_NAME`. |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :file:`zephyr.signed.hex` | Secondary slot variant of the :file:`app_signed.hex` file intended for use when MCUboot is in the :doc:`direct-xip mode <mcuboot:design>`. |
| :file:`zephyr.signed.hex` | Secondary slot variant of the :file:`zephyr.signed.hex` file intended for use when MCUboot is in the :doc:`direct-xip mode <mcuboot:design>`. |
| :file:`mcuboot_secondary_app` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| :file:`mcuboot_secondary_app` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |
| :file:`mcuboot_secondary_app/zephyr` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |

@@ -147,11 +147,11 @@ MCUboot output build files
| | It will not trigger a DFU procedure. |
| | ``zephyr`` is the value of :kconfig:option:`CONFIG_KERNEL_BIN_NAME`. |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :file:`zephyr.signed.bin` in | Secondary slot variant of the :file:`app_update.bin` file intended for use when MCUboot is in the :doc:`direct-xip mode <mcuboot:design>`. |
| :file:`zephyr.signed.bin` in | Secondary slot variant of the :file:`zephyr.signed.bin` file intended for use when MCUboot is in the :doc:`direct-xip mode <mcuboot:design>`. |
| :file:`mcuboot_secondary_app` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| :file:`mcuboot_secondary_app` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |
| :file:`mcuboot_secondary_app/zephyr` folder | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled. |

greg-fer added a commit to greg-fer/fw-nrfconnect-nrf-1 that referenced this pull request Feb 7, 2025
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 nrfconnect#20005 and nrfconnect#20153.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
nordicjm pushed a commit that referenced this pull request Feb 7, 2025
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>
@b-gent b-gent force-pushed the NCSDK-30871_fix_output_build_file_names branch from deed120 to d1fe692 Compare February 25, 2025 14:02
Copy link

github-actions bot commented Feb 25, 2025

After documentation is built, you will find the preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-20153/nrf/app_dev/config_and_build/output_build_files.html

Correct the names according to NCSDK-30871.

Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
@b-gent b-gent force-pushed the NCSDK-30871_fix_output_build_file_names branch from d1fe692 to d2c85b9 Compare February 25, 2025 14:14
@rlubos rlubos merged commit 532c80c into nrfconnect:main Mar 19, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants