3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-11 13:40:53 +00:00
Commit graph

15 commits

Author SHA1 Message Date
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
f0b4f7012e
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-08-05 09:54:00 +12:00
Krystine Sherwin
20a573953c
bugpoint.rst: Minimizing scripts
part 2: electric boogaloo
2025-08-05 09:54:00 +12:00
Krystine Sherwin
113a6f6e52
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-08-05 09:54:00 +12:00
Krystine Sherwin
c75b07820f
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-08-05 09:53:59 +12:00
Krystine Sherwin
e776f1dca2
bugpoint.rst: More paragraphs
What do I do with the minimized design and (the first half of) Minimizing scripts
2025-08-05 09:53:59 +12:00
Krystine Sherwin
9fa1f76cf2
bugpoint.rst: Why context matters (bullets) 2025-08-05 09:53:59 +12:00
Krystine Sherwin
2c534c8828
Docs: How to use bugpoint paragraphs 2025-08-05 09:53:59 +12:00
Krystine Sherwin
47c89a61df
Docs: What is bugpoint in paragraphs 2025-08-05 09:53:58 +12:00
Krystine Sherwin
be999219a2
docs: User-defined failures in bugpoint
Also some other tidy up and clarifications.
2025-08-05 09:53:58 +12:00
Krystine Sherwin
8ec3e3a102
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-08-05 09:53:58 +12:00
Krystine Sherwin
aefe3443aa
docs: Minimizing synth with -run bullets 2025-08-05 09:53:57 +12:00
Krystine Sherwin
6e1cc9c0cd
docs: Some extra bugpoint bullets 2025-08-05 09:53:57 +12:00
Krystine Sherwin
3784f6b17f
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-08-05 09:53:57 +12:00
Krystine Sherwin
074f5e7ea6
Docs: Initial outline of minimizing designs
How to guide for using bugpoint, minimizing yosys scripts, and minimizing verilog code.
AKA how to MVCE.
2025-08-05 09:53:56 +12:00