3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2026-06-06 17:11:01 +00:00
Commit graph

80 commits

Author SHA1 Message Date
Krystine Sherwin
72f5836fb1
docs: Resolving todos
Make explicit the location for the `CMakeUserPresets.json` file.
Update docs tests documentation.
Move `BUILD_DIR` and `PROGRAM_PREFIX` comments into the functional tests todo.
Add cmake to MacPorts/FreeBSD install instructions.
Add ccache to example `CMakeUserPresets.json` (it isn't otherwise documented, and is no longer as obvious without an `ENABLE_CCACHE` makevar).

Addressing comments
2026-06-04 20:35:52 +12:00
Krystine Sherwin
776995c74d
WIP docs 2026-06-04 20:34:51 +12:00
Miodrag Milanovic
35d13e1c32 Update documentation/demos based on cleanup 2026-05-18 09:13:46 +02:00
Miodrag Milanovic
1ef6311e5b Update documentation and few more defines 2026-05-13 11:24:45 +02:00
Emil J. Tywoniak
9b9e334c79 contributing: small responses to feedback 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
cc3827c80c docs: consolidate contributing.md into contributing.rst harder 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
9385928bc2 contributing: Yosys HQ -> YosysHQ 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
d6518f1b9a contributing: fix links 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
342b0e5fc1 contributing: require bug report inputs to pass check 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
8bf42c01ce contributing: finish cut off sentence 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
d75d513402 contributing: reformulate HQ GmbH involvement 2026-04-07 18:59:06 +02:00
Emil J. Tywoniak
98c3f03497 docs: clarify vanilla test run-test.sh 2026-02-11 00:58:29 +01:00
Emil J. Tywoniak
ff9cd0eed7 Makefile: test target requires unit-test, add vanilla-test for old test target 2026-02-09 23:21:24 +01:00
Emil J. Tywoniak
b8497217bc contributing: review process 2026-01-13 00:16:58 +01:00
Emil J. Tywoniak
16a420afee contributing: clarify some things 2025-12-05 12:16:14 +01:00
Emil J. Tywoniak
518610bbc4 contributing: split out git style 2025-12-04 17:26:51 +01:00
Emil J. Tywoniak
2843ea3008 contributing: fix rst 2025-12-03 13:10:20 +01:00
Emil J. Tywoniak
e2dffbf991 contributing: move to docs, expand 2025-12-03 12:30:17 +01:00
Emil J. Tywoniak
436a247d60 Shuffle around information about bug reports and contributions 2025-12-03 12:30:17 +01:00
Krystine Sherwin
cc5642c904 Docs: Bringing prereqs in line
Add comments in setup-build-env/action.yml for where to document prereqs (and the separation between build/run and test).
Add some initial (very basic) text for `test_suites.rst`, listing prereqs and how to run the tests (with subsections for the different optional tests, which is currently docs, functional and unit).
Add sphinx-inline-tabs, use it for tidying up prereq instructions based on OS/platform (mostly helpful in the test suites doc where there are multiple sections split by OS).
Also fixes some single backticks that should be double backtick.
2025-11-04 07:40:36 +01:00
Emil J. Tywoniak
dc7764e247 .github: typos 2025-09-30 11:03:19 +02:00
Emil J. Tywoniak
b86cc0d9b3 docs: replace Slack with Discourse in extensions writing guide 2025-09-29 23:20:06 +02:00
Krystine Sherwin
96b072aeb3
advanced_bugpoint.rst: --dump-design
Also fix missing double backtick.
2025-08-05 09:54:02 +12:00
Krystine Sherwin
c994b59ac6
advanced_bugpoint.rst: Paragraphing 2025-08-05 09:54:01 +12:00
Krystine Sherwin
c47b533a3d
docs: Split bugpoint.rst into user/developer
Minimizing scripts (and more generally identifying root cause) isn't necessary for regular bug reports.  Rather, it can be useful for developers working on *fixing* bugs, and also for fuzzers to avoid spam.
Minor adjustments to `bugpoint.rst`.
Add note to `advanced_bugpoint.rst` about primitives when minimizing scripts.
2025-08-05 09:54:01 +12:00
Krystine Sherwin
65b75049aa
docs: Shuffling bug reporting guidelines
Move the "creating an issue" section from bugpoint.rst to "reporting bugs" in `contributing.rst`.
Fix link to `CONTRIBUTING.md`.
Update `CONTRIBUTING.md` to refer to the bugpoint guide instead of the stack overflow guide.
2025-08-05 09:54:00 +12:00
Krystine Sherwin
cd3b914132
Reinstate #4768
Revert the reversion so that we can fix the bugs that the PR missed.
2025-04-08 11:58:05 +12:00
Miodrag Milanović
d49364d96f
Revert "Refactor full_selection" 2025-04-07 12:11:55 +02:00
KrystalDelusion
98d4355b82
Merge pull request #4768 from YosysHQ/krys/refactor_selections
Refactor full_selection
2025-04-05 14:15:27 +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
Krystine Sherwin
dac2bb7d4d
Use selection helpers
Catch more uses of selection constructor without assigning a design.
2025-03-14 14:08:13 +13: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
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
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
Krystine Sherwin
242c037158
docs/rosette: Add overview 2025-01-24 13:10:34 +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
Krystine Sherwin
c1f42f725b
Docs: Formatting recent md -> rst converts 2024-12-05 09:21:12 +13:00