Skip to content

Commit 667a742

Browse files
committed
doc: twister: add documentation of integration_toolchains
Document the new option and how to use integration_toolchains. Signed-off-by: Anas Nashif <[email protected]>
1 parent 1f7bf5a commit 667a742

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

doc/develop/test/twister.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,40 @@ integration_platforms: <YML list of platforms/boards>
478478
platform_allow if the goal is to limit scope due to timing or
479479
resource constraints.
480480

481+
integration_toolchains: <YML list of toolchain variants>
482+
This option expands the scope to all the listed toolchains variants and
483+
adds another vector of testing where desired. By default, test
484+
configurations are generated based on the toolchain configured in the environment:
485+
486+
test scenario -> platforms1 -> toolchain1
487+
test scenario -> platforms2 -> toolchain1
488+
489+
490+
When a platform supports multiple toolchains that are available during the
491+
twister run, it is possible to expand the test configurations to include
492+
additional tests for each toolchain. For example, if a platform supports
493+
toolchains ``toolchain1`` and ``toolchain2``, and the test scenario
494+
includes:
495+
496+
.. code-block:: yaml
497+
498+
integration_toolchains:
499+
- toolchain1
500+
- toolchain2
501+
502+
the following configurations are generated:
503+
504+
test scenario -> platforms1 -> toolchain1
505+
test scenario -> platforms1 -> toolchain2
506+
test scenario -> platforms2 -> toolchain1
507+
test scenario -> platforms2 -> toolchain2
508+
509+
510+
.. note::
511+
512+
This functionality is evaluated always and is not limited to the
513+
``--integration`` option.
514+
481515
platform_exclude: <list of platforms>
482516
Set of platforms that this test scenario should not run on.
483517

0 commit comments

Comments
 (0)