Skip to content

Commit dece6f9

Browse files
lmapiikartben
authored andcommitted
doc: ztest: add a note about host restrictions for unit testing
Running unit tests on macOS or Windows is currently not supported due to fundamental differences in the architectures. Added a note in the "Quick start - Unit testing" section about this restriction. Signed-off-by: Martin Lampacher <martin.lampacher@gmail.com>
1 parent acbc86a commit dece6f9

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/develop/test/ztest.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,15 @@ is invoked the script zephyr/scripts/pylib/twister/twisterlib/testplan.py
367367
filters out all testcases.yml in which type: unit is not set. Only unit tests
368368
are executed with a firmware build with BOARD=unit_testing.
369369

370+
.. note::
371+
Unit tests are run as **native** applications on the host and are therefore
372+
subject to similar :ref:`limitations <posix_arch_limitations>` as documented
373+
for the :ref:`POSIX architecture<Posix arch>`. Running unit tests is
374+
therefore only supported for Linux. To run unit tests on Windows or macOS
375+
it is necessary to use containers or Virtual Machines running a Linux guest.
376+
Follow the same instructions as for the
377+
:ref:`POSIX Arch dependencies<posix_arch_deps>`.
378+
370379
CMakeLists.txt
371380
==============
372381

0 commit comments

Comments
 (0)