Skip to content

Commit 53486c9

Browse files
nashifkartben
authored andcommitted
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 08ed0f3 commit 53486c9

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
@@ -490,6 +490,40 @@ integration_platforms: <YML list of platforms/boards>
490490
platform_allow if the goal is to limit scope due to timing or
491491
resource constraints.
492492

493+
integration_toolchains: <YML list of toolchain variants>
494+
This option expands the scope to all the listed toolchains variants and
495+
adds another vector of testing where desired. By default, test
496+
configurations are generated based on the toolchain configured in the environment:
497+
498+
test scenario -> platforms1 -> toolchain1
499+
test scenario -> platforms2 -> toolchain1
500+
501+
502+
When a platform supports multiple toolchains that are available during the
503+
twister run, it is possible to expand the test configurations to include
504+
additional tests for each toolchain. For example, if a platform supports
505+
toolchains ``toolchain1`` and ``toolchain2``, and the test scenario
506+
includes:
507+
508+
.. code-block:: yaml
509+
510+
integration_toolchains:
511+
- toolchain1
512+
- toolchain2
513+
514+
the following configurations are generated:
515+
516+
test scenario -> platforms1 -> toolchain1
517+
test scenario -> platforms1 -> toolchain2
518+
test scenario -> platforms2 -> toolchain1
519+
test scenario -> platforms2 -> toolchain2
520+
521+
522+
.. note::
523+
524+
This functionality is evaluated always and is not limited to the
525+
``--integration`` option.
526+
493527
platform_exclude: <list of platforms>
494528
Set of platforms that this test scenario should not run on.
495529

0 commit comments

Comments
 (0)