Skip to content

Commit

Permalink
doc: twister: Add details on required_snippets
Browse files Browse the repository at this point in the history
Adds information on the new required_snippets feature

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
  • Loading branch information
nordicjm committed Aug 24, 2023
1 parent 4e35905 commit a692c8f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/develop/test/twister.rst
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,24 @@ filter: <expression>

Would match it.

required_snippets: <list of needed snippets>
:ref:`Snippets <snippets>` are supported in twister for test cases that
require them. As with normal applications, twister supports using the base
zephyr snippet directory and test application directory for finding
snippets. Listed snippets will filter supported tests for boards (snippets
must be compatible with a board for the test to run on them, they are not
optional).

The following is an example yaml file with 2 required snippets.

::

tests:
snippet.example:
required_snippets:
- cdc-acm-console
- user-snippet-example

The set of test cases that actually run depends on directives in the testcase
filed and options passed in on the command line. If there is any confusion,
running with -v or examining the discard report
Expand Down

0 comments on commit a692c8f

Please sign in to comment.