3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-02 17:30:24 +00:00

Document tests/functional prereqs

This commit is contained in:
Krystine Sherwin 2025-07-07 11:27:37 +12:00
parent 108a4ed496
commit dcf72ff8e2
No known key found for this signature in database

View file

@ -14,6 +14,24 @@ compiler versions. For up to date information, including OS versions, refer to
.. _Yosys Git repo: https://github.com/YosysHQ/yosys
.. _the git actions page: https://github.com/YosysHQ/yosys/actions
Functional backend testing
--------------------------
Testing of the functional backend is controlled by the
``ENABLE_FUNCTIONAL_TESTS`` make variable. Setting it to a value of ``1``,
either when calling ``make test`` or in your ``Makefile.conf`` file, will enable
these additional tests.
.. note::
The functional backend tests requires additional prerequisites to be
installed:
- racket and z3, available via ``apt-get`` or similar.
- pytest and pytest-xdist, available via ``pip``; pytest-xdist-gnumake is
also recommended.
- rosette, available via ``raco`` (after installing racket).
.. todo:: are unit tests currently working
..