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.

Sign up for GitHub

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

Jump to bottom

doc: SUIT DFU customize guide fixes for 2.8.0 #17928

Merged
merged 1 commit into from
Oct 23, 2024
Merged

doc: SUIT DFU customize guide fixes for 2.8.0 #17928

merged 1 commit into from
Oct 23, 2024

Conversation

ahasztag
Copy link
Contributor

This commit updates this part of the documentation taking into account changes for 2.8.0 release

@ahasztag ahasztag requested a review from a team as a code owner October 16, 2024 12:57
@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 Oct 16, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Oct 16, 2024 •
edited
Loading

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 002ebbca7817d0ec34c5854d91fbb8af89807370

more details

sdk-nrf:

PR head: 002ebbca7817d0ec34c5854d91fbb8af89807370
merge base: 08116dd44b6076fd643a34b18182287bc50dc763
target head (main): 08116dd44b6076fd643a34b18182287bc50dc763
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 (2) 
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── working_with_nrf
│  │  │  │  │  ├── nrf54h
│  │  │  │  │  │  ├── ug_nrf54h20_suit_customize_dfu.rst
│  │  │  │  │  │  │ ug_nrf54h20_suit_customize_qsg.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_nrf_provisioning
    • 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

@ahasztag ahasztag force-pushed the NCSDK-29731_doc_fixes_customize_dfu branch from c8cbbba to 94ddb0d Compare October 16, 2024 13:23
jnsgsr
jnsgsr approved these changes Oct 16, 2024
View reviewed changes
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_dfu.rst Outdated
@@ -7,7 +7,7 @@ How to customize the SUIT DFU process
:local:
:depth: 2

Nordic Semiconductor provides a Software Update Internet of Things (SUIT) sample (:ref:`ug_nrf54h20_suit_intro`) which uses predefined configurations in the build system.
Nordic Semiconductor provides a :ref:`Software Update Internet of Things (SUIT) sample <nrf54h_suit_sample>` which uses predefined configurations in the build system.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: The acronym SUIT stands for 'Software Update for Internet of Things' and not 'Software Update Internet of Things'.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

maciejpietras
maciejpietras reviewed Oct 17, 2024
View reviewed changes
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_dfu.rst Outdated
@@ -264,6 +265,7 @@ With the Python dictionary you are able to, for example:
* Obtain the size of partition with ``application['dt'].chosen_nodes['zephyr,code-partition'].regs[0].size``
* Get the pair of URI name and the binary path by using ``'#{{ application['name'] }}': {{ application['binary'] }}``
* Get the root manifest sequence number with ``suit-manifest-sequence-number: {{ APP_ROOT_SEQ_NUM }}``
* Gey thr vendor name by using ``application['config']['CONFIG_SUIT_MPI_APP_LOCAL_1_VENDOR_NAME']``
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
* Gey thr vendor name by using ``application['config']['CONFIG_SUIT_MPI_APP_LOCAL_1_VENDOR_NAME']``
* Get the vendor name by using ``application['config']['CONFIG_SUIT_MPI_APP_LOCAL_1_VENDOR_NAME']``

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

maciejpietras
maciejpietras requested changes Oct 17, 2024
View reviewed changes
Copy link
Contributor

@maciejpietras maciejpietras left a comment

Choose a reason for hiding this comment

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

Small typos

@ahasztag
doc: SUIT DFU customize guide fixes for 2.8.0
002ebbc 
This commit updates this part of the documentation
taking into account changes for 2.8.0 release

Signed-off-by: Artur Hadasz <[email protected]>
@ahasztag ahasztag force-pushed the NCSDK-29731_doc_fixes_customize_dfu branch from 0626c50 to 002ebbc Compare October 18, 2024 10:29
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

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

@rlubos rlubos merged commit 4d6b85d into nrfconnect:main Oct 23, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adsz-nordic adsz-nordic adsz-nordic approved these changes

@maciejpietras maciejpietras maciejpietras approved these changes

@FrancescoSer FrancescoSer FrancescoSer approved these changes

@jnsgsr jnsgsr jnsgsr approved these changes

@SylwesterKonczyk SylwesterKonczyk Awaiting requested review from SylwesterKonczyk

@robertstypa robertstypa Awaiting requested review from robertstypa

@kszromek-nordic kszromek-nordic Awaiting requested review from kszromek-nordic

@tomchy tomchy Awaiting requested review from tomchy

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@ahasztag @NordicBuilder @tomchy @jnsgsr @FrancescoSer @maciejpietras @adsz-nordic @rlubos