-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
doc: fix output build file names #20153
Conversation
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: d2c85b90eb8dc3b81ad49de3756ce2f0b07e6379 more detailssdk-nrf:
Github labels
List of changed files detected by CI (1)
Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
786622c
to
deed120
Compare
You can find the documentation preview for this PR at this link. Note: This comment is automatically posted by the Documentation Publish GitHub Action. |
There was a problem hiding this 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.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| :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. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| :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. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| :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. | |
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>
deed120
to
d1fe692
Compare
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>
d1fe692
to
d2c85b9
Compare
|
Correct the names according to NCSDK-30871.