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: tfm: Add documentation regarding configurable build #19562

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

SeppoTakalo
Copy link
Contributor

Add documentation regarding CONFIG_TFM_PROFILE_TYPE_NOT_SET and various TF-M partitions that user need to configure.

NOTE: This is very early phase. This work is still in progress, but I'm just starting the review process very early.

@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 Dec 16, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Dec 16, 2024

CI Information

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

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 Publish GitHub Action.

@SeppoTakalo SeppoTakalo force-pushed the tfm_partition_docs branch 3 times, most recently from 426dd6c to 536d653 Compare December 23, 2024 14:04
Copy link
Contributor

@MarkusLassila MarkusLassila left a comment

Choose a reason for hiding this comment

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

Some comments. Moving to right direction.

@SeppoTakalo SeppoTakalo requested a review from melwee01 December 30, 2024 12:40
@MarkusLassila MarkusLassila force-pushed the tfm_partition_docs branch 2 times, most recently from 82f0ec3 to de44e9e Compare January 20, 2025 11:45
@SeppoTakalo SeppoTakalo marked this pull request as ready for review January 21, 2025 13:03
@SeppoTakalo SeppoTakalo requested review from a team as code owners January 21, 2025 13:03
@peknis
Copy link
Contributor

peknis commented Jan 21, 2025

More comments/suggestions coming later this week.

@SeppoTakalo SeppoTakalo changed the title WIP: doc: tfm: Add documentation regarding configurable build doc: tfm: Add documentation regarding configurable build Jan 22, 2025
@SeppoTakalo SeppoTakalo removed the DNM label Jan 22, 2025
@SeppoTakalo SeppoTakalo force-pushed the tfm_partition_docs branch 2 times, most recently from dc41adb to e06cb9f Compare January 22, 2025 13:50
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.

Almost there :)

@SeppoTakalo SeppoTakalo force-pushed the tfm_partition_docs branch 2 times, most recently from 003a4c3 to e6cc22b Compare February 4, 2025 11:35
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.

Looks good. As discussed with both Seppo and Markus, more improvements can be made, but we can tackle them in separate PRs.

@SeppoTakalo SeppoTakalo force-pushed the tfm_partition_docs branch 2 times, most recently from c68aed4 to a58b96b Compare February 5, 2025 13:20
@SeppoTakalo SeppoTakalo removed 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 5, 2025
@peknis peknis added doc-required PR must not be merged without tech writer approval. CI-disable Disable CI for this PR labels Feb 5, 2025
@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 5, 2025
Add documentation regarding CONFIG_TFM_PROFILE_TYPE_NOT_SET
and various TF-M partitions that user need to configure.

Move SPM migration guide to own page

Current user guide does not need this information anymore.
It should be moved to a separate migration guide.

Restructure sections

Move building, configuring and limitations to
appear before background information on TF-M user
guide.

Signed-off-by: Seppo Takalo <[email protected]>
Signed-off-by: Markus Lassila <[email protected]>
@rlubos rlubos merged commit 34d87b5 into nrfconnect:main Feb 6, 2025
13 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. 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.

9 participants