3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-11 21:50:54 +00:00
Commit graph

109 commits

Author SHA1 Message Date
Krystine Sherwin
20a51742f4
Docs: Fix cmd links from bugpoint docs 2025-08-06 13:52:13 +12:00
Krystine Sherwin
3959d19291
Reapply "Add groups to command reference"
This reverts commit 81f87ce6ed.
2025-08-06 13:52:12 +12:00
Krystine Sherwin
8750ca42d3
docs: Fix formatting 2025-08-05 09:54:02 +12:00
Krystine Sherwin
bfe2418a67
bugpoint.rst: Expand note on checking errors 2025-08-05 09:54:02 +12:00
Krystine Sherwin
4924670325
bugpoint.rst: How to sv-bugpoint 2025-08-05 09:54:02 +12:00
Krystine Sherwin
29d334186c
bugpoint.rst: How to creduce 2025-08-05 09:54:01 +12:00
Krystine Sherwin
6b7756b67a
bugpoint.rst: Finish paragraphs
Update text to assume bugpoint PR changes.
2025-08-05 09:54:01 +12:00
Krystine Sherwin
aa6c6fd283
bugpoint.rst: Some paragraphs on verilog 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
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
385d58562d
Docs: Move verilog.rst to using_yosys
Was previously in yosys_internals which is more developer focused, rather than user focused.
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
db3dc45bc6
Docs: Tidying
Fix error on duplicated heading.
Drop `cmd_ref`_ link (everything already uses :doc:`cmd_ref`).
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
3a07020875
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-08-05 09:53:56 +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
N. Engelhardt
81f87ce6ed
Revert "Add groups to command reference" 2025-07-23 14:41:49 +00:00
Krystine Sherwin
0ec336ba23
Docs: Add :cmd:title: directive
Calling :cmd:title:`<cmd>` will generate a cross reference to `<cmd>`, but unlike :cmd:ref: which displays a literal block and puts the title (short_help) in the hovertext (the title field of an a-ref), :cmd:title: will display "<cmd> - <short_help>" as plain text.
Thus replacing the previous use case of referring to :doc:`cmd/<cmd>`.
Also refactor util py scripts to have more descriptive names.
2025-07-21 10:35:19 +12:00
Krystine Sherwin
7647d2c741
Docs: Fix warnings
Changes a bunch of :doc:`/cmd/*` to :cmd:ref:`*` with the intention of changing it later to something that replicates the previous effect of displaying the commands `short_help`.
2025-07-21 10:34:32 +12:00
Martin Povišer
62067cd6cb Update docs after addition of new pass 2025-07-05 16:45:52 +02:00
KrystalDelusion
06db8828b2
abc.rst: Clarify larger-but-slower 2025-05-31 09:10:27 +12:00
Gary Wong
7a9d727bd0 docs: several small documentation fixes. 2025-05-29 21:26:28 -06: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
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
Krystine Sherwin
4ea6119734
cmdref: Move html only section inside cmd:def
Fixes missing links in body and `??` in tag/command index.
Update synth.rst to match.
2024-10-17 06:06:57 +13:00
Krystine Sherwin
e40134c856
Docs: Update for properties
Add properties page, move cell_gate and cell_word under a singular cell_index along with properties.  Fix links accordingly.

Also drop x-aware and x-output todos since they are resolved.
2024-10-15 07:35:41 +13:00
Krystine Sherwin
e78841ba45
Docs: Fix invalid autorefs 2024-10-15 07:34:53 +13:00
Krystine Sherwin
be5572ca0e
Docs: Less leading backslashes 2024-10-15 07:34:52 +13:00
Krystine Sherwin
2b4a4cb536
Docs: Fix fsm.rst
`$mux-tree` should be `$mux`-tree.
2024-10-15 07:34:52 +13:00
Krystine Sherwin
1374fc2e2b
cellref: Deprecate cell_library.rst
Most of the word/coarse level cells have an assigned group and individual page.
The gate/fine level cells are all on one page.
Fix links to `cell_library.rst`.
2024-10-15 07:34:52 +13:00
Krystine Sherwin
40ba92e956
Docs: Reflow line length 2024-10-15 07:23:45 +13:00
Krystine Sherwin
829e02ec5b
Docs: Shorten cmd:ref 2024-10-15 07:22:04 +13:00
Krystine Sherwin
e4ec3717bc
Docs: Update internal cells to autoref 2024-10-15 07:18:28 +13:00
Krystine Sherwin
840c515ffc
RTDs: Fail on warning
Fix outstanding sphinx warnings;
- Change mycells.lib to use `text` parsing instead of (currently) unsupported `Liberty`.
- Remove unused `troubleshooting.rst`, moving the todo into the index.
2024-09-03 10:20:24 +12:00
Krystine Sherwin
583d820dc2
Docs: Apply verific docs suggestions 2024-08-23 09:23:57 +12:00