PSA core 5.12 #986
PSA core 5.12 #986
Conversation
There was a problem hiding this comment.
Please see my questions/comments.
We should also add examples to the API pages (see, for, instance https://os.mbed.com/docs/mbed-os/v5.11/apis/kvstore.html).
| @@ -0,0 +1,11 @@ | |||
| ## Platform service | |||
|
|
|||
| The Platform service introduces System Reset and PSA Lifecycle APIs. | |||
There was a problem hiding this comment.
@alzix, can you please elaborate on what the platform service is? I see that it consists of the Lifecycle API, which we have documented separately, and the System Reset API. Since Lifecycle is already documented, should we just have a System Reset page? Is there anything else we can say about the system reset? When would you use it? Also, the class reference here is for the Lifecycle API. Can we put the System Reset API class reference instead?
|
|
||
| ### PSA protected storage class reference | ||
|
|
||
| [](../mbed-os-api-doxy/protected__storage_8h.html) |
There was a problem hiding this comment.
I didn't think the Doxygen transclusions worked with the ../ links. Have you tried this in the preview? If you have and it does, I'll have to start using this.
There was a problem hiding this comment.
@AnotherButler, it seems to work :) Have a look: http://docs-previewer.herokuapp.com/mbed-os-5-docs/PSA-docs/apis/psa-protected-storage.html.
| @@ -0,0 +1,11 @@ | |||
| digraph { | |||
There was a problem hiding this comment.
What is this file? What does it do?
| @@ -0,0 +1,3 @@ | |||
| #!/usr/bin/env bash | |||
There was a problem hiding this comment.
What is this file? What does it do?
| @@ -1 +1,3 @@ | |||
| tags | |||
There was a problem hiding this comment.
What is this file? What does it do?
add psa_lifecycle description add psa_platform description add TF-M porting guide extend porting guide with targets and labels description
according to docs sync meeting
|
@GuyWi, updated platform service doc |
* Docs from "PSA core 5.12 PR #986". * Update docs.json * Updated docs.json and file locations. * Update docs.json * Removed doxy link. * Updated links. * More link fixes. * Added psa_lifecycle.jpg. * Delete psa_lifecycle.jpg * Adding psa_lifecycle.png. * Updates. * Adding links from storage to PSA storage. * Update psa.md * Update psa_crypto.md * Update psa_internal_storage.md * Create testing_psa_service_compliance.md * Update psa_crypto.md * Adding PSA porting section. * Update docs.json * Updated docs.json. * Update docs.json * Update psa_lifecycle.md * Updated doc.json * Update psa_attestation.md * Update psa_attestation.md * Update psa_attestation.md * Moved PSA main page to the Security landing page. * Update porting_psa.md * Update security.md * Update security.md * Update spm.md * Update storage.md * Removed empty Example sections in API docs. * Delete .gitignore * Delete psa_crypto.md * Update platform_service.md * Update docs.json * Delete porting_psa.md * Delete testing_psa_service_compliance.md * Update docs.json * Update docs.json * Update platform_service.md
|
I'm closing this PR because it's been continued in PR #995 |
CC @GuyWi @avolinski @amiraloosh
based on #982