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: flpr and building for nrf54l15 #17443

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

annwoj
Copy link
Contributor

@annwoj annwoj commented Sep 23, 2024

Adds building article
Adds FLPR intro

@annwoj annwoj added doc-required PR must not be merged without tech writer approval. CI-disable Disable CI for this PR changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Sep 23, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Sep 23, 2024

CI Information

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

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. It will be updated about 10 minutes after the documentation build succeeds.

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

doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst Outdated Show resolved Hide resolved
@annwoj annwoj added this to the 2.8.0 milestone Oct 23, 2024
@annwoj annwoj added the backport v2.8-branch auto-create a PR with same commits to v2.8-branch label Oct 25, 2024
@annwoj annwoj force-pushed the nrf54l15_building_flpr branch 2 times, most recently from d00a133 to 806dc5a Compare October 30, 2024 12:22
@annwoj annwoj marked this pull request as ready for review October 30, 2024 12:22
@annwoj annwoj added the DNM label Nov 5, 2024
@annwoj annwoj dismissed greg-fer’s stale review November 5, 2024 11:34

all changes applied

@annwoj annwoj force-pushed the nrf54l15_building_flpr branch 3 times, most recently from 702e1b8 to e04ce36 Compare November 6, 2024 08:34
@annwoj annwoj removed the DNM label Nov 6, 2024
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.

The mention of VPR Launcher is confusing to me. I think it is a mistake to call a sample that uses a snippet with a proper name that suggests it is a sort of external tool. See my comments for more issues around this.

doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved

.. group-tab:: Using VPR Launcher

VPR launcher is a minimal sample that allows to start the FLPR core.
Copy link
Contributor

Choose a reason for hiding this comment

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

VPR launcher is a minimal sample built for an ARM core that starts given VPR core.

This is what https://github.com/zephyrproject-rtos/zephyr/blob/main/soc/nordic/common/vpr/Kconfig.sysbuild#L9-L11 from @masz-nordic states. With the comment from @wbober ("This is not a sample per se."), the Kconfig description is clearly wrong and needs to be fixed.

To be honest, I don't think we should use the name "VPR launcher" at all - not here nor in the Kconfig.
For me, the name suggests an external app or a tool. I can imagine some users will have a similar idea.
If it is a minimal sample with a snippet, it is clearly not a tool or an external app.

The current edit ("VPR launcher allows to start the FLPR core.") is unfortunately not addressing my original comment anymore because it doesn't provide a clear definition.

Please change this before merging this PR.

doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst Outdated Show resolved Hide resolved
@annwoj annwoj added the DNM label Nov 6, 2024
@annwoj annwoj requested a review from greg-fer November 6, 2024 13:35
@annwoj annwoj force-pushed the nrf54l15_building_flpr branch 2 times, most recently from 5b5a069 to 00fc0d3 Compare November 6, 2024 14:05
@annwoj annwoj removed the DNM label Nov 6, 2024
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.

Three nits.

Adds building article
Adds FLPR intro

Signed-off-by: Anna Wojdylo <[email protected]>
@rlubos rlubos merged commit 62dca66 into nrfconnect:main Nov 6, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v2.8-branch auto-create a PR with same commits to v2.8-branch changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. CI-disable Disable CI for this PR doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.