riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
yosys/docs/source/test_suites.rst

26 lines
738 B
ReStructuredText
Raw Normal View History

Docs: optimization passes Working on `opt.rst`. Replace the hardcoded `opt` psuedo code listing with a `literalinclude` from `/cmd/opt.rst`. Reorder and update `opt_*` list to match current `opt`. Expand sub-section titles with the function of the pass (keeping the `:cmd:ref:` part at the end to prevent the Esbonio error in vscode when a heading starts with a directive). Move comments about `clean` and `;;` being aliases into final `opt` subsection. Also renames `Test suites` -> `Testing Yosys`.
2024-01-14 18:15:11 -06:00
Testing Yosys
=============
New structure headings Also adds a note to readme for installing pdflatex if it's missing.
2023-08-02 16:20:24 -05:00
Updates to install and tests Includes CAD suite info and details on the OSS CAD suite nightly build targets. Instructions for building from source, largely based on the readme but with some minor modifications. Tests are still WIP, but we replaced the old test suites with a brief comment on the github workflow tests. Still needs more on the tests themselves and how to run them locally. Also an extra todo on the index page.
2023-12-10 17:44:05 -06:00
.. todo:: more about the included test suite
Include test suites doc with note
2023-08-02 16:20:30 -05:00
Updates to install and tests Includes CAD suite info and details on the OSS CAD suite nightly build targets. Instructions for building from source, largely based on the readme but with some minor modifications. Tests are still WIP, but we replaced the old test suites with a brief comment on the github workflow tests. Still needs more on the tests themselves and how to run them locally. Also an extra todo on the index page.
2023-12-10 17:44:05 -06:00
Automatic testing
-----------------
New structure headings Also adds a note to readme for installing pdflatex if it's missing.
2023-08-02 16:20:24 -05:00
TODOs Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
2023-12-11 17:05:45 -06:00
.. only:: html
Docs: changes from JF `yosys-witness` prereq `click`. Yosys environment vars & `yosys --help` output. Removing Ubuntu/macOS version numbers/names. Hide `troubleshooting` page.
2024-01-22 22:35:06 -06:00
The `Yosys Git repo`_ has automatic testing of builds and running of the
included test suite on the following platforms:
- Ubuntu |test-linux|
- macOS |test-macos|
Finished presentation intro Also some other tidy up.
2023-08-02 16:20:30 -05:00
Updates to install and tests Includes CAD suite info and details on the OSS CAD suite nightly build targets. Instructions for building from source, largely based on the readme but with some minor modifications. Tests are still WIP, but we replaced the old test suites with a brief comment on the github workflow tests. Still needs more on the tests themselves and how to run them locally. Also an extra todo on the index page.
2023-12-10 17:44:05 -06:00
.. _Yosys Git repo: https://github.com/YosysHQ/yosys
Finished presentation intro Also some other tidy up.
2023-08-02 16:20:30 -05:00
chore: fix master branch refs Signed-off-by: Rui Chen <rui@chenrui.dev>
2024-03-23 23:41:40 -05:00
.. |test-linux| image:: https://github.com/YosysHQ/yosys/actions/workflows/test-linux.yml/badge.svg?branch=main
.. |test-macos| image:: https://github.com/YosysHQ/yosys/actions/workflows/test-macos.yml/badge.svg?branch=main
Docs: changes from JF `yosys-witness` prereq `click`. Yosys environment vars & `yosys --help` output. Removing Ubuntu/macOS version numbers/names. Hide `troubleshooting` page.
2024-01-22 22:35:06 -06:00
For up to date information, including OS versions, refer to `the git actions
page`_.
.. _the git actions page: https://github.com/YosysHQ/yosys/actions