3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-07 14:43:23 +00:00
Commit graph

319 commits

Author SHA1 Message Date
Krystine Sherwin
a9d4579765
advanced_bugpoint.rst: Paragraphing 2025-05-23 10:52:54 +12:00
Krystine Sherwin
1b3566af42
bugpoint.rst: Finish paragraphs
Update text to assume bugpoint PR changes.
2025-05-23 10:52:54 +12:00
Krystine Sherwin
8a5e00a9ef
bugpoint.rst: Some paragraphs on verilog 2025-05-23 10:52:54 +12:00
Krystine Sherwin
6e2695a206
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-05-23 10:52:54 +12:00
Krystine Sherwin
8ba612bc23
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-05-23 10:52:54 +12:00
Krystine Sherwin
b23a081f80
bugpoint.rst: Extra notes
Move `yosys -h bugpoint` failure into a code-block to break up text.  Same for the `exec -expect-return` example.
TODOs on #5068 being merged.
2025-05-23 10:52:54 +12:00
Krystine Sherwin
4c95e6993e
bugpoint.rst: Minimizing scripts
part 2: electric boogaloo
2025-05-23 10:52:53 +12:00
Krystine Sherwin
bbc954ca99
bugpoint.rst: yosys -h bugpoint does work
I just missed that it only gets included in the makefile if `DISABLE_SPAWN` is set, because I was looking for the C define `YOSYS_DISABLE_SPAWN`.
2025-05-23 10:52:53 +12:00
Krystine Sherwin
3db588a972
Docs: More bugpoint bullets
More info for creating GitHub issues and the different sections.
Discuss additional details that can be included as comments on the issue.  Also mention Gists for large files (preferable to downloading a .txt).
Add a warning about external plugins/tools.
Also add a note to `load_design.rst` about `Frontend`s and `-f` command line option.
2025-05-23 10:52:53 +12:00
Krystine Sherwin
d94c82140e
bugpoint.rst: More paragraphs
What do I do with the minimized design and (the first half of) Minimizing scripts
2025-05-23 10:52:53 +12:00
Krystine Sherwin
cb1fa668e7
bugpoint.rst: Why context matters (bullets) 2025-05-23 10:52:53 +12:00
Krystine Sherwin
72dd57ecef
Docs: How to use bugpoint paragraphs 2025-05-23 10:52:53 +12:00
Krystine Sherwin
1eea1be7c5
Docs: What is bugpoint in paragraphs 2025-05-23 10:51:47 +12:00
Krystine Sherwin
3e6884c1d7
docs: User-defined failures in bugpoint
Also some other tidy up and clarifications.
2025-05-23 10:51:46 +12:00
Krystine Sherwin
7b7d90160f
Docs: Move verilog.rst to using_yosys
Was previously in yosys_internals which is more developer focused, rather than user focused.
2025-05-23 10:51:46 +12:00
Krystine Sherwin
2b84005836
docs: Bullets for identifying issues
Add a note on fuzzers, with a polite suggestion that if you're fuzzing you should put in the work of identifying the underlying issue so that you (and we) are confident you're not raising multiple issues for the same bug.
2025-05-23 10:51:46 +12:00
Krystine Sherwin
bb0606b379
docs: Minimizing synth with -run bullets 2025-05-23 10:51:46 +12:00
Krystine Sherwin
57e6b9caf9
docs: Some extra bugpoint bullets 2025-05-23 10:51:46 +12:00
Krystine Sherwin
830605dc89
Docs: Tidying
Fix error on duplicated heading.
Drop `cmd_ref`_ link (everything already uses :doc:`cmd_ref`).
2025-05-23 10:51:46 +12:00
Krystine Sherwin
c705193fd4
Docs: Bugpoint fixups from JF
Also dropping the `autosectionlabel_maxdepth = 1` so that I can actually use the auto section labels.
Adds warning on bash substitution on scripting intro page when talking about `yosys -p`.
2025-05-23 10:51:46 +12:00
Krystine Sherwin
b986180057
docs: Outline loading a design page
Talk about input files coming from command line, the `read` command, and features provided by `RTLIL::Frontend` (making note that `read_slang` is a subclass but `ghdl` isn't).
2025-05-23 10:51:46 +12:00
Krystine Sherwin
b960d9860d
Docs: Initial outline of minimizing designs
How to guide for using bugpoint, minimizing yosys scripts, and minimizing verilog code.
AKA how to MVCE.
2025-05-23 10:51:37 +12:00
Miodrag Milanovic
53c22ab7c0 Release version 0.53 2025-05-06 07:45:16 +02:00
Emily Schmidt
19845be85c reflow dft docs to 80 cols 2025-04-15 09:57:14 +01:00
Emily Schmidt
bfed96ad88 some fixes and rewordings of the dft docs 2025-04-15 09:57:14 +01:00
Emily Schmidt
ea6e5b3c48 add changes to dft docs suggested by Krystine 2025-04-15 09:57:14 +01:00
Emily Schmidt
30486079f9 add dft_tag documentation 2025-04-15 09:57:14 +01:00
N. Engelhardt
3410e10ed5
Merge pull request #5000 from YosysHQ/krys/re_refactor_selections 2025-04-10 16:06:36 +00:00
Emily Schmidt
32ec5a9ccd Revert "add dft_tag documentation"
This reverts commit 2443facc46.
2025-04-09 10:34:11 +01:00
Emily Schmidt
2443facc46 add dft_tag documentation 2025-04-09 10:18:25 +01:00
Miodrag Milanovic
fee39a3284 Release version 0.52 2025-04-09 07:38:42 +02: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
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
Krystine Sherwin
dac2bb7d4d
Use selection helpers
Catch more uses of selection constructor without assigning a design.
2025-03-14 14:08:13 +13: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