adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

samples: tfm_integration: use zephyr:code-sample directive

Browse source 
Adds missing code-sample directive to all the tfm_integration samples in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-09-11 17:52:38 +02:00 committed by Mahesh Mahadevan
parent 1471c2f814
commit 171f687136
6 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
samples/tfm_integration/psa_crypto/README.rst
View file

@ -1,7 +1,7 @@
.. _tfm_psa_crypto: .. zephyr:code-sample:: tfm_psa_crypto
:name: TF-M PSA crypto
TF-M PSA crypto Use the PSA Crypto API for cryptography and device certificate signing requests.
################
Overview Overview
******** ********

8
samples/tfm_integration/psa_protected_storage/README.rst
View file

@ -1,7 +1,7 @@
.. psa_protected_storage: .. zephyr:code-sample:: psa_protected_storage
:name: TF-M PSA Protected Storage
PSA Protected Storage Use the Protected Storage (PS) API to store encrypted data.
#####################
Overview Overview
******** ********
@ -41,7 +41,7 @@ run as the overwrite protection will not be removed with a power reset.
On QEMU On QEMU
======== ========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
Following is an example based on ``west build`` Following is an example based on ``west build``
.. code-block:: bash .. code-block:: bash

6
samples/tfm_integration/tfm_ipc/README.rst
View file

@ -1,7 +1,7 @@
.. _tfm_ipc: .. zephyr:code-sample:: tfm_ipc
:name: TF-M IPC
TF-M IPC Implement communication between the secure and non-secure images using IPC.
########
Overview Overview
******** ********

4
samples/tfm_integration/tfm_psa_test/README.rst
View file

@ -40,12 +40,12 @@ Note that not all test suites are valid on all boards.
On Target On Target
========= =========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
On QEMU: On QEMU:
======== ========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
Following is an example based on ``west build`` Following is an example based on ``west build``
.. code-block:: bash .. code-block:: bash

4
samples/tfm_integration/tfm_regression_test/README.rst
View file

@ -24,12 +24,12 @@ Tests for both the secure and non-secure domain are enabled by default, controll
On Target On Target
========= =========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
On QEMU: On QEMU:
======== ========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
Following is an example based on ``west build`` Following is an example based on ``west build``
.. code-block:: bash .. code-block:: bash

10
samples/tfm_integration/tfm_secure_partition/README.rst
View file

@ -1,7 +1,7 @@
.. _tfm_secure_partition: .. zephyr:code-sample:: tfm_secure_partition
:name: TF-M Secure Partition
TF-M Secure Partition Sample Create a secure partition that exposes secure services.
############################
Overview Overview
******** ********
@ -38,12 +38,12 @@ This sample can be built with or without CONFIG_TFM_IPC, since it contains code
On Target On Target
========= =========
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
On QEMU On QEMU
======= =======
Refer to :ref:`tfm_ipc` for detailed instructions. Refer to :zephyr:code-sample:`tfm_ipc` for detailed instructions.
Sample Output Sample Output
============= =============