patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

doc: use a linked reference rather than a GitHub reference.

Browse source 
Instead of sending the user out of the documentation site to GitHub
to read the testing instructions, link to the generated page for the
documentation.

Signed-off-by: Diego Elio Pettenò <flameeyes@meta.com>
This commit is contained in:
Diego Elio Pettenò 2023-08-06 17:19:26 +01:00 committed by Carles Cufí
parent 0ad0dea200
commit 00dadc6c38
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
samples/sample_definition_and_criteria.rst
View file

@ -24,12 +24,12 @@ Sample Criteria
* If a sample can provide output that can be verified, then output should be evaluated against * If a sample can provide output that can be verified, then output should be evaluated against
expected value to have some level of testing for the sample itself. expected value to have some level of testing for the sample itself.
Refer to :zephyr_file:`doc/develop/test/twister.rst` for more details. Refer to :ref:`twister_script` for more details.
* Samples are optional. * Samples are optional.
2. Twister should be able to build every sample. 2. Twister should be able to build every sample.
++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++
* Every sample must have a YAML file. Reference: :zephyr_file:`doc/develop/test/twister.rst`. * Every sample must have a YAML file. Reference: :ref:`twister_script`.
**For example:** **For example:**
@ -62,7 +62,7 @@ Sample Criteria
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* Minimize the use of ``platform_allow`` and architecture filters as it limits the scope * Minimize the use of ``platform_allow`` and architecture filters as it limits the scope
of testing to the mentioned platforms and architectures. of testing to the mentioned platforms and architectures.
Reference: :zephyr_file:`doc/develop/test/twister.rst` Reference: :ref:`twister_script`
* Make use of ``integration_platforms`` to limit the scope when there are timing or * Make use of ``integration_platforms`` to limit the scope when there are timing or
resource constraints. resource constraints.
* Make the sample as generic as possible. Avoid making a sample platform specific unless it is * Make the sample as generic as possible. Avoid making a sample platform specific unless it is