3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-04 16:44:08 +00:00
Commit graph

303 commits

Author SHA1 Message Date
KrystalDelusion cce7aaedf7
Merge pull request #4939 from DanielG/rsync-fallback
mk: Fall back to cp if rsync is not available
2025-03-25 10:41:27 +13:00
KrystalDelusion 644efca341
Merge pull request #4953 from YosysHQ/krys/local_docs_fixes
A few fixes, mostly local docs builds
2025-03-25 10:36:18 +13:00
Daniel Gröber 2b67ad78bf mk: Fall back to cp if rsync is not available 2025-03-24 18:06:17 +01:00
Krystine Sherwin 39a1623ac0
Docs: Don't READTHEDOCS on local builds 2025-03-18 03:57:17 +13:00
Krystine Sherwin 8877817fa9
Fix Docs issues for offline pdf builds #4777
Drop svg badges.  Even though they were only appearing in the html version, the latexpdf target was still trying to download them, leading to warnings-as-errors in offline builds.
2025-03-15 12:14:09 +13:00
Scott Ashcroft d8af6b0616 docs: Add latex magic to make PDFs reproducible again 2025-03-14 21:48:08 +01:00
Martin Povišer 6da543a61a
Merge pull request #4818 from povik/macc_v2
Add `$macc_v2`
2025-03-12 22:55:40 +01:00
Miodrag Milanovic c4b5190229 Release version 0.51 2025-03-12 08:31:37 +01:00
N. Engelhardt c74df780b7
Merge pull request #4884 from YosysHQ/docs-preview-functional_tutorial
Docs: More on FunctionalIR
2025-03-10 15:05:55 +00:00
Krystine Sherwin c9785584da
docs/rosette: Fix tenses 2025-03-07 08:39:21 +13:00
Krystine Sherwin b56e3ec6e4
docs/functional: Minimal backend paragraphs
I was thinking about compiling the dummy example and including a simple example usage, but it turns out functional.h isn't (currently) available for extensions.
2025-03-01 16:15:54 +13:00
Krystine Sherwin 3c493d2bef
docs/rosette: Reword
Acknowledge the minimal functional backend, highlighting what's new/different for our SExpr targets.
Add and use the reference `minimal backend`.
Use `note` directives to point out missing code sections (highlighting that the included diffs are not complete).
Racket *is* still strongly-typed, it's just dynamic instead of static.  Adjust phrasing to reflect that.
Adjust some of the literal includes, adding a new section from the `Functional::AbstractVisitor`, splitting the `Module::write_eval()` in twain and adding a `smtlib.cc` literal include for the node iteration, as well as for the `FunctionalSmtBackend` to compare against the minimal backend.
Move `Backend` description up to minimal functional backend section.
2025-02-28 16:33:57 +13:00
Krystine Sherwin e01a413722
docs/rosette: List major changes in overview
Also a little paragraph on why SMT-LIB is used as the base.
2025-02-28 14:57:41 +13:00
Krystine Sherwin 560b5fe6bd
docs/functional: Add dummy toy example
Add `dummy.cc`, loosely based on `backends/functional/test_generic.cc` but as an actualy backend and without the memory testing.
Skeleton section for minimal functional backend, describing the aforementioned `dummy.cc`.
2025-02-27 16:14:59 +13:00
Krystine Sherwin db823a6acb
docs/rosette: Fix inline code 2025-02-27 16:11:44 +13:00
Krystine Sherwin c429aef60f
docs/rosette: More intro of SMT-LIB backend
As the intro paragraph (now) says:
> This section will introduce the SMT-LIB functional backend and what changes are needed...

The example is intended to be read without prior knowledge of the SMT-LIB backend, but the previous version glossed over a lot and instead focused on *just* what was changed.
This version should now be easier to follow without prior knowledge, while still being able to learn enough about the `Smt` version to adapt it to a different s-expression target that isn't Rosette.
Also adds a few `literalinclude`s of smtlib.cc, which is now copied to `docs/source/generated` along with producing the rosette diff on the fly (which now also has up to 20 lines of context, enabling the full `Module::write()` diff to be literal included).
2025-02-22 17:14:13 +13:00
Krystine Sherwin 38746ea5fa
docs: Cross reference contributing
.md points to .html on latest
.rst points to .md on main (not that it will work before this is merged)
2025-02-20 14:16:41 +13:00
Miodrag Milanovic b5170e1394 Release version 0.50 2025-02-11 07:55:17 +01:00
Krystine Sherwin 819c3260ec
docs/rosette: Backend section body 2025-02-07 15:33:40 +13:00
Krystine Sherwin b02d2c633e
docs/rosette: Module section body 2025-02-07 15:09:06 +13:00
Krystine Sherwin 34c424be68
docs/rosette: Minor updates
- Fixing typo
- Reference `write_functional_rosette`
- Adjusting/fixing diff sections
- Comment on why the `code-block:: diff` isn't a `literalinclude`
2025-02-07 15:08:24 +13:00
Krystine Sherwin dc5a5b7bd1
docs/rosette: Regen rosette.diff
This time from the actual source, which apparently means changing all of the spaces for tabs.
2025-02-07 14:13:34 +13:00
Krystine Sherwin d73c58fad1
docs/rosette: Sort, Struct, and PrintVisitor sections 2025-02-04 12:24:34 +13:00
Krystine Sherwin 1b6b6a77ba
docs/rosette: Add details for Scope
Add a diff file and use it for showing changes from smtlib to rosette.
Also add relevant sections of diff to Sort and Struct sections.
2025-01-25 09:51:20 +13:00
Martin Povišer 61450e8b6e Update codebase for macc_v2 2025-01-24 12:38:03 +01:00
Krystine Sherwin 242c037158
docs/rosette: Add overview 2025-01-24 13:10:34 +13:00
Miodrag Milanovic 427b5a251b Release version 0.49 2025-01-21 14:59:09 +01:00
Emil J da5c20dcfb
Merge pull request #4849 from YosysHQ/emil/hashlib-merge-top-ops
hashlib: merge hash_ops with hash_top_ops for plugin compat
2025-01-21 12:09:27 +01:00
Emil J. Tywoniak a2c26a00f2 hashlib: document merged hash_top_ops with hash_ops 2025-01-20 16:25:52 +01:00
KrystalDelusion 0c61f1a9a8
conf.py: Fix source_directory 2025-01-20 16:30:30 +13:00
KrystalDelusion ab4bda8ae2
Docs: Fix links for view/edit source 2025-01-20 16:19:36 +13:00
Krystine Sherwin f4c7377ac1
functional_ir.rst: Fix typo 2025-01-06 14:30:55 +13:00
Krystine Sherwin 23fa9b2014
functional_ir.rst: Initial skeleton for Rosette 2025-01-06 14:30:29 +13:00
Krystine Sherwin ef7734d610
functional_ir.rst: Formatting
Line breaks.
Put intro under sub-heading.
2025-01-06 12:01:21 +13:00
KrystalDelusion 9e039095e9
Docs: Remove restructure note
It's been almost a year since the restructure, so it's not recent anymore and doesn't need to link back to the old version.
2025-01-06 11:08:00 +13:00
Emil J. Tywoniak b9b9515bb0 hashlib: hash_eat -> hash_into 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 0a525f38c2 hashlib: declare YS_HASHING_VERSION = 1 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 4e29ec1854 hashlib: acc -> eat 2024-12-18 15:09:25 +01:00
Emil J. Tywoniak 79acc141d5 hashlib: add deprecated mkhash function to prevent plugin breakage 2024-12-18 14:58:53 +01:00
Emil J. Tywoniak 6d53454bf5 docs: move hashing-based container details into internal docs from guidelines 2024-12-18 14:58:53 +01:00
Emil J 1401906d81 docs: formatting and fixes
Co-authored-by: KrystalDelusion <93062060+KrystalDelusion@users.noreply.github.com>
2024-12-18 14:58:53 +01:00
Krystine Sherwin 0454787443 Docs: Formatting and fixes 2024-12-18 14:58:51 +01:00
Emil J. Tywoniak ad0dc17711 docs: document the ideas behind the hashing interface 2024-12-18 14:58:31 +01:00
Miodrag Milanovic aaa5347494 Release version 0.48 2024-12-11 08:35:36 +01:00
Krystine Sherwin 40af327cb6
Docs/installation: Drop resolved todos 2024-12-05 09:21:13 +13:00
Krystine Sherwin 6b3f2fdc8d
Docs: Installation instructions
Add warning for Cygwin.
Add commented out instructions for MSYS2 that I tried to get to work but ran into build errors.
2024-12-05 09:21:13 +13:00
Krystine Sherwin b9d73d0a8e
Docs: Note on releases 2024-12-05 09:21:13 +13:00
Krystine Sherwin a7ea375cfc
Docs/installation: Fix code indentation
Update FreeBSD line to include CXX as well as CC.
Drop unneeded todo.
2024-12-05 09:21:13 +13:00
Krystine Sherwin 0aef78245e
Moving primary build instructions to docs
Also drop visual studio instructions.
2024-12-05 09:21:13 +13:00
Krystine Sherwin c1f42f725b
Docs: Formatting recent md -> rst converts 2024-12-05 09:21:12 +13:00