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: mcuboot: fix outdated links + multi-image #20226

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented 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 #20005 and #20153.

@greg-fer greg-fer added CI-disable Disable CI for this PR doc only labels Feb 6, 2025
@greg-fer greg-fer added this to the 3.0.0 milestone Feb 6, 2025
@greg-fer greg-fer requested a review from a team as a code owner February 6, 2025 13:36
@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 Feb 6, 2025
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 6, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Feb 6, 2025

CI Information

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

Inputs:

Sources:

more details

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 (0)

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

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

@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.

These ``.hex`` files are identical to the ones listed above, but their names also use the ``mcuboot_secondary_`` prefix.
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.
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.
For example, :file:`mcuboot_secondary_app/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.
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
For example, :file:`mcuboot_secondary_app/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.
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.

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 <[email protected]>
@greg-fer greg-fer force-pushed the doc_mcuboot_wrapper_links branch from 20c97cb to bac95e1 Compare February 7, 2025 09:50
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 7, 2025
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 7, 2025
@nordicjm nordicjm merged commit e24e07c into nrfconnect:main Feb 7, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-disable Disable CI for this PR doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants