Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manual rewrite and presentation merge #3907

Merged
merged 115 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
115 commits
Select commit Hold shift + click to select a range
4f1cd66
New structure headings
KrystalDelusion Aug 2, 2023
045c040
Reorganising documentation
KrystalDelusion Aug 2, 2023
cd6e63e
Moved presentation_prog
KrystalDelusion Aug 2, 2023
20c2708
Move presentation intro example
KrystalDelusion Aug 2, 2023
9a9aa2c
Finished presentation intro
KrystalDelusion Aug 2, 2023
2c75b10
Include test suites doc with note
KrystalDelusion Aug 2, 2023
4b40372
Tidy/reflow some things
KrystalDelusion Aug 2, 2023
330a227
Converting PRESENTATION_ExSyn
KrystalDelusion Aug 3, 2023
7ab0517
Add copypaste reminder for typical_phases.rst
KrystalDelusion Aug 6, 2023
8ade218
Move (most of) ExOth and ExAdv slides
KrystalDelusion Aug 7, 2023
afc25af
Minor tidying
KrystalDelusion Aug 7, 2023
ce9e56d
Move the last presentation slides
KrystalDelusion Aug 7, 2023
d8b8880
Convert todo comments to directives
KrystalDelusion Aug 7, 2023
8203a01
Adding custom domain for cmdref
KrystalDelusion Aug 7, 2023
9fcf353
Makefile adjustments to match top make
KrystalDelusion Aug 7, 2023
f8333e5
cmd links use title text
KrystalDelusion Aug 8, 2023
685da6a
Converting a number of inline commands to refs
KrystalDelusion Aug 8, 2023
e2c0f8f
Some tidy up
KrystalDelusion Aug 14, 2023
aad8a3b
Rearrange command ordering and model checking
KrystalDelusion Aug 27, 2023
70c4769
Updating todo text and assorted fixes
KrystalDelusion Aug 27, 2023
93c9bf2
docs: Updating todos
KrystalDelusion Sep 18, 2023
10ecbe9
docs: updating memory mapping text
KrystalDelusion Sep 18, 2023
98d0e74
Merge updates from 'master' into krys/docs
KrystalDelusion Sep 18, 2023
b0f8059
Moving images and static folders
KrystalDelusion Oct 9, 2023
a019c26
docs: Moving 011 into main body of manual
KrystalDelusion Oct 9, 2023
9e35848
docs: initial 011 selections move
KrystalDelusion Oct 9, 2023
c61ab7d
docs: Tidying interactive investigation
KrystalDelusion Oct 10, 2023
8335044
docs: reflowing selections doc
KrystalDelusion Oct 10, 2023
ebcbb94
Fixing makefile
KrystalDelusion Oct 11, 2023
5a7a7b3
Fix make clean
KrystalDelusion Oct 11, 2023
17749ce
docs: absolute cmd directory
KrystalDelusion Oct 16, 2023
abd9222
Replace 010 and 012 with pdf
KrystalDelusion Oct 29, 2023
a1c3755
Fix typo
KrystalDelusion Oct 29, 2023
e49903f
List all synth commands on synth page
KrystalDelusion Oct 29, 2023
d4e45cd
docs: Stub new(er) auxlibs and auxprogs
KrystalDelusion Oct 29, 2023
74c1fc1
docs: Reference chapters with doc tag
KrystalDelusion Oct 30, 2023
8e07030
docs: update auxiliary programs
KrystalDelusion Oct 31, 2023
2b10bd5
docs: update images makefile
KrystalDelusion Oct 31, 2023
8fad77b
Merge branch 'master' into krys/docs
KrystalDelusion Nov 1, 2023
a283595
docs: call make resources before make all
KrystalDelusion Nov 1, 2023
3d70867
docs: remove synth_machxo2, add _lattice
KrystalDelusion Nov 13, 2023
dbc38d7
docs: moving code examples
KrystalDelusion Nov 13, 2023
b6e61c1
docs: restructuring images directory
KrystalDelusion Nov 14, 2023
2b270b2
docs: Tidying image generation
KrystalDelusion Nov 15, 2023
bb7ebec
guidelines: fix paths to moved files
KrystalDelusion Nov 15, 2023
0fb5119
docs: more tidying
KrystalDelusion Nov 15, 2023
a8b2525
typical phases: Expand/split sections
KrystalDelusion Dec 4, 2023
bad8dba
Correcting plurals
KrystalDelusion Dec 4, 2023
f9ce3d1
WIP merging synth phases with example
KrystalDelusion Dec 7, 2023
1e3b90a
Removing typical phases doc
KrystalDelusion Dec 7, 2023
aef9921
Tidying TODOs
KrystalDelusion Dec 7, 2023
25f6a98
Updating the intro
KrystalDelusion Dec 7, 2023
f949579
Testing latexpdf build
KrystalDelusion Dec 7, 2023
4ecceae
Updates to install and tests
KrystalDelusion Dec 10, 2023
e34a25e
TODOs
KrystalDelusion Dec 11, 2023
1733a76
Updated ABC info
KrystalDelusion Dec 12, 2023
7f24ef3
Add todo
KrystalDelusion Dec 12, 2023
afe8eff
Merge updated master into krys/docs
KrystalDelusion Dec 12, 2023
f44e8d0
Working on extensions doc
KrystalDelusion Dec 12, 2023
3a153f9
Add cell_libs.rst
KrystalDelusion Dec 13, 2023
6d1caf6
Initial synth_ice40 example
KrystalDelusion Dec 13, 2023
80c78aa
New example_synth code
KrystalDelusion Dec 14, 2023
742ec78
Switching example synth to fifo
KrystalDelusion Dec 18, 2023
a33b1b6
More work on example_synth
KrystalDelusion Dec 18, 2023
50d8c1b
First pass example_synth done
KrystalDelusion Dec 20, 2023
9f1c445
docs: work on example_synth
KrystalDelusion Jan 2, 2024
3e653fe
docs: more on wreduce in synth starter
KrystalDelusion Jan 3, 2024
e6f8804
example_synth: more on DSP mapping
KrystalDelusion Jan 8, 2024
eb5da87
example_synth: hardware mapping
KrystalDelusion Jan 8, 2024
064723a
example_synth: tidying
KrystalDelusion Jan 13, 2024
a3255fd
Docs: opt_rmunused -> opt_clean
KrystalDelusion Jan 13, 2024
12fa443
example_synth: more on hierarchy and stat
KrystalDelusion Jan 13, 2024
3360c61
Docs: remove hanging reference
KrystalDelusion Jan 13, 2024
9eab5d8
Updated Yosys family
KrystalDelusion Jan 14, 2024
9fe3dcd
Docs: optimization passes
KrystalDelusion Jan 15, 2024
646ff6d
Docs: interactive investigation
KrystalDelusion Jan 15, 2024
5a4c2e5
example_synth: proc and opt_expr
KrystalDelusion Jan 16, 2024
aa652f9
Docs: fix scripting_intro.rst images
KrystalDelusion Jan 16, 2024
14f2208
Docs: opt_expr
KrystalDelusion Jan 16, 2024
63a0f80
Docs: opt_share
KrystalDelusion Jan 16, 2024
27ae093
Docs: working on opt page
KrystalDelusion Jan 16, 2024
93ceda5
Docs: auxlibs
KrystalDelusion Jan 17, 2024
74d2c91
Docs: installation/source tree
KrystalDelusion Jan 18, 2024
14b7c58
Docs: reworking scripting_intro
KrystalDelusion Jan 18, 2024
794ad38
Docs: scripting_intro/show_intro
KrystalDelusion Jan 21, 2024
65bb0d3
Docs: updating to current 'master'
KrystalDelusion Jan 21, 2024
9ec1536
Docs: getting_started tidy
KrystalDelusion Jan 21, 2024
e63f1f5
Docs: merge CI fix
KrystalDelusion Jan 23, 2024
95849ed
Docs: changes from JF
KrystalDelusion Jan 23, 2024
6c8949c
Docs: static opt macro list
KrystalDelusion Jan 23, 2024
449135a
Docs: adding other macro command lists
KrystalDelusion Jan 23, 2024
9b82010
Docs: add test-docs.yml
KrystalDelusion Jan 23, 2024
e10d9b1
Remove python dep from test-docs
KrystalDelusion Jan 24, 2024
57a7532
Docs: add test-examples target
KrystalDelusion Jan 24, 2024
bb4d690
Docs: can we re-use build artifacts?
KrystalDelusion Jan 24, 2024
4ac983e
test-docs: Checkout Yosys
KrystalDelusion Jan 24, 2024
2a14c72
test-docs: target examples directly
KrystalDelusion Jan 24, 2024
62d2f89
Revert artifact reuse
KrystalDelusion Jan 24, 2024
6e38848
Docs: updating makefiles
KrystalDelusion Jan 24, 2024
4582ab5
Docs: intro to memory_libmap
KrystalDelusion Jan 25, 2024
e2e7065
Docs: some restructure of advanced section
KrystalDelusion Jan 26, 2024
22808e0
Docs: work on selections.rst
KrystalDelusion Jan 26, 2024
a7e1c6e
codeowners: adopting docs folder
KrystalDelusion Jan 26, 2024
9878e69
Docs: tidying
KrystalDelusion Jan 30, 2024
fd0c574
Docs: changes/todos from JF
KrystalDelusion Jan 30, 2024
fae35fe
Docs: example_synth fifo update
KrystalDelusion Jan 30, 2024
9eed04d
Docs: Note on debug for memory_libmap
KrystalDelusion Feb 5, 2024
3596025
docs: Remove TODOs from output
KrystalDelusion Mar 4, 2024
1455941
Merge branch 'master' into krys/docs
KrystalDelusion Mar 4, 2024
3635f91
Docs: Updates from @povik comments
KrystalDelusion Mar 4, 2024
bc9ccca
docs: Move fifo localparams into module def
KrystalDelusion Mar 17, 2024
2832034
docs: Clarify install instructions
KrystalDelusion Mar 17, 2024
d2bf5a8
Merge branch 'origin/master' into krys/docs
KrystalDelusion Mar 17, 2024
b6ffdec
docs: Update OSS CAD suite info
KrystalDelusion Mar 17, 2024
49f1bea
docs: Add synth_ice40 to macro checks
KrystalDelusion Mar 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Stub new(er) auxlibs and auxprogs
Still need to actually be filled in.
Also rearranges auxlibs to be alphabetical order.
  • Loading branch information
KrystalDelusion committed Oct 29, 2023
commit d4e45cdccb80297a40330a3fe8700730f3e53063
49 changes: 35 additions & 14 deletions docs/source/appendix/auxlibs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------
Expand All @@ -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
-----
Expand All @@ -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`).
10 changes: 10 additions & 0 deletions docs/source/appendix/auxprogs.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
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.

Expand All @@ -27,3 +29,11 @@ This is a fork of ABC with a small set of custom modifications that have not yet
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.

yosys-smtbmc
------------

yosys-witness
-------------

yosys-witness is a new tool to inspect and convert yosys witness traces.