mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-13 01:16:16 +00:00
Code Activity

docs: update auxiliary programs

Browse source 
Now includes usage output, (hopefully) generated by the tool during the docs build process so it will always be up to date.
Included in makefile as `docs/usage` target.
Also some updates/additions to the description text, esp `yosys-filterlib` and `yosys-smtbmc`.
This commit is contained in:
Krystine Sherwin 2023-11-01 10:13:28 +13:00
parent 74c1fc1cdd
commit 8e07030fee
No known key found for this signature in database
3 changed files with 38 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/source/appendix/auxprogs.rst
View file

@ -1,26 +1,32 @@
Auxiliary programs
==================
.. todo:: check this list is up to date and correct, esp yosys-smtbmc
Besides the main yosys executable, the Yosys distribution contains a set of
additional helper programs.
yosys-config
------------
The yosys-config tool (an auto-generated shell-script) can be used to query
The ``yosys-config`` tool (an auto-generated shell-script) can be used to query
compiler options and other information needed for building loadable modules for
Yosys. See :doc:`/yosys_internals/extensions` for details.
.. literalinclude:: /temp/yosys-config
:start-at: Usage
.. _sec:filterlib:
yosys-filterlib
---------------
The yosys-filterlib tool is a small utility that can be used to strip or extract
information from a Liberty file. See :ref:`sec:techmap_extern` for
details.
.. todo:: how does a filterlib rules-file work? is this still supported?
The ``yosys-filterlib`` tool is a small utility that can be used to strip or
extract information from a Liberty file. This can be useful for removing
sensitive or proprietary information such as timing or other trade secrets.
.. literalinclude:: /temp/yosys-filterlib
:start-at: Usage
yosys-abc
---------
@ -30,10 +36,24 @@ been accepted upstream. Not all versions of Yosys work with all versions of ABC.
So Yosys comes with its own yosys-abc to avoid compatibility issues between the
two.
.. literalinclude:: /temp/yosys-abc
:start-at: usage
:end-before: UC Berkeley
yosys-smtbmc
------------
The ``yosys-smtbmc`` tool is a utility used by SBY for interacting with smt
solvers.
.. literalinclude:: /temp/yosys-smtbmc
yosys-witness
-------------
yosys-witness is a new tool to inspect and convert yosys witness traces.
``yosys-witness`` is a new tool to inspect and convert yosys witness traces.
This is used in SBY and SCY for producing traces in a consistent format
independent of the solver.
.. literalinclude:: /temp/yosys-witness
:start-at: Usage