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

docs: Stub new(er) auxlibs and auxprogs

Browse source 
Still need to actually be filled in.
Also rearranges auxlibs to be alphabetical order.
This commit is contained in:
Krystine Sherwin 2023-10-30 11:13:48 +13:00
parent e49903f8b1
commit d4e45cdccb
No known key found for this signature in database
2 changed files with 45 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

49
docs/source/appendix/auxlibs.rst
View file

@ -4,12 +4,7 @@ Auxiliary libraries
The Yosys source distribution contains some auxiliary libraries that are bundled
with Yosys.
SHA1
----
The files in ``libs/sha1/`` provide a public domain SHA1 implementation written
by Steve Reid, Bruce Guenter, and Volker Grabsch. It is used for generating
unique names when specializing parameterized modules.
.. todo:: fill out the newer auxiliary libs
BigInt
------
@ -22,15 +17,10 @@ ConstEval class provided in kernel/consteval.h.
See also: http://mattmccutchen.net/bigint/
.. _sec:SubCircuit:
dlfcn-win32
-----------
SubCircuit
----------
The files in ``libs/subcircuit`` provide a library for solving the subcircuit
isomorphism problem. It is written by C. Wolf and based on the Ullmann Subgraph
Isomorphism Algorithm :cite:p:`UllmannSubgraphIsomorphism`. It is used by the
extract pass (see :doc:`../cmd/extract`).
The files in ``libs/dlfcn-win32`` provide...
ezSAT
-----
@ -40,3 +30,34 @@ formulas for SAT solvers. It also contains bindings of MiniSAT. The ezSAT
library is written by C. Wolf. It is used by the sat pass (see
:doc:`../cmd/sat`).
fst
---
The files in ``libs/fst`` provide...
json11
------
The files in ``libs/json11`` provide...
MiniSAT
-------
The files in ``libs/minisat`` provide...
SHA1
----
The files in ``libs/sha1/`` provide a public domain SHA1 implementation written
by Steve Reid, Bruce Guenter, and Volker Grabsch. It is used for generating
unique names when specializing parameterized modules.
.. _sec:SubCircuit:
SubCircuit
----------
The files in ``libs/subcircuit`` provide a library for solving the subcircuit
isomorphism problem. It is written by C. Wolf and based on the Ullmann Subgraph
Isomorphism Algorithm :cite:p:`UllmannSubgraphIsomorphism`. It is used by the
extract pass (see :doc:`../cmd/extract`).