Skip to content

Commit

Permalink
doc: twister: add documentation of integration_toolchains
Browse files Browse the repository at this point in the history
Document the new option and how to use integration_toolchains.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
  • Loading branch information
nashif authored and kartben committed Jan 8, 2025
1 parent 08ed0f3 commit 53486c9
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions doc/develop/test/twister.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,40 @@ integration_platforms: <YML list of platforms/boards>
platform_allow if the goal is to limit scope due to timing or
resource constraints.

integration_toolchains: <YML list of toolchain variants>
This option expands the scope to all the listed toolchains variants and
adds another vector of testing where desired. By default, test
configurations are generated based on the toolchain configured in the environment:

test scenario -> platforms1 -> toolchain1
test scenario -> platforms2 -> toolchain1


When a platform supports multiple toolchains that are available during the
twister run, it is possible to expand the test configurations to include
additional tests for each toolchain. For example, if a platform supports
toolchains ``toolchain1`` and ``toolchain2``, and the test scenario
includes:

.. code-block:: yaml
integration_toolchains:
- toolchain1
- toolchain2
the following configurations are generated:

test scenario -> platforms1 -> toolchain1
test scenario -> platforms1 -> toolchain2
test scenario -> platforms2 -> toolchain1
test scenario -> platforms2 -> toolchain2


.. note::

This functionality is evaluated always and is not limited to the
``--integration`` option.

platform_exclude: <list of platforms>
Set of platforms that this test scenario should not run on.

Expand Down

0 comments on commit 53486c9

Please sign in to comment.