3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-29 03:45:52 +00:00
Commit graph

88 commits

Author SHA1 Message Date
Krystine Sherwin
29f9347fd2
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-04-28 16:43:39 +12:00
Krystine Sherwin
e52c93598b
bugpoint.rst: Minimizing scripts
part 2: electric boogaloo
2025-04-28 11:46:44 +12:00
Krystine Sherwin
e9adc30f9d
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-04-26 14:37:37 +12:00
Krystine Sherwin
a461870050
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-04-17 16:23:36 +12:00
Krystine Sherwin
5d04baad0c
bugpoint.rst: More paragraphs
What do I do with the minimized design and (the first half of) Minimizing scripts
2025-04-17 16:20:33 +12:00
Krystine Sherwin
43504f1927
bugpoint.rst: Why context matters (bullets) 2025-04-04 16:43:06 +13:00
Krystine Sherwin
b429fba5ac
Docs: How to use bugpoint paragraphs 2025-03-25 17:06:05 +13:00
Krystine Sherwin
3dde02e730
Docs: What is bugpoint in paragraphs 2025-03-25 12:05:41 +13:00
Krystine Sherwin
a3fcfddb34
bugpoint: Document -wires flag 2025-03-22 17:17:19 +13:00
Krystine Sherwin
c4f6e90cc5
docs: User-defined failures in bugpoint
Also some other tidy up and clarifications.
2025-03-22 16:57:46 +13:00
Krystine Sherwin
47202f51f3
Docs: Move verilog.rst to using_yosys
Was previously in yosys_internals which is more developer focused, rather than user focused.
2025-03-22 14:18:57 +13:00
Krystine Sherwin
db0a707b44
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-03-21 16:31:33 +13:00
Krystine Sherwin
94a4ea299e
docs: Minimizing synth with -run bullets 2025-03-21 11:54:54 +13:00
Krystine Sherwin
507e316d92
docs: Some extra bugpoint bullets 2025-03-21 11:32:46 +13:00
Krystine Sherwin
80d742fe5a
Docs: Tidying
Fix error on duplicated heading.
Drop `cmd_ref`_ link (everything already uses :doc:`cmd_ref`).
2025-03-20 10:09:41 +13:00
Krystine Sherwin
6913726fac
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-03-18 14:55:41 +13:00
Krystine Sherwin
165e2d7a92
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-03-13 14:50:59 +13:00
Krystine Sherwin
cf6e96ba59
Docs: Initial outline of minimizing designs
How to guide for using bugpoint, minimizing yosys scripts, and minimizing verilog code.
AKA how to MVCE.
2025-03-11 17:11:26 +13: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
Krystine Sherwin
6431534c24
Docs: Some other fixes 2024-08-22 10:03:59 +12:00
Krystine Sherwin
00bb3b6fc2
Docs: Merge yosys_source into extending_yosys
Move abc_flow content into synthesis/abc document.
2024-08-22 10:03:59 +12:00
Krystine Sherwin
2ffafadf22
Docs: Add note on verific
Having a verific license does not provide access to the verific frontend.
2024-08-22 10:03:58 +12:00
James Meech
1c41db6978
Update interactive_investigation.rst
The text starting at line 118 refers to proc twice but it should refer to opt and then to proc.
2024-07-26 13:53:08 +01:00
Krystine Sherwin
3a36612ec7
Docs: Apply invert-helper where needed 2024-05-11 10:40:54 +12:00
Rui Chen
b57a803f60
chore: fix master branch refs
Signed-off-by: Rui Chen <rui@chenrui.dev>
2024-03-24 00:41:54 -04:00
Krystine Sherwin
f72ddfb09d docs: Fix repo file links 2024-03-19 05:57:26 +13:00
Krystine Sherwin
9eed04dd4b
Docs: Note on debug for memory_libmap 2024-02-05 15:38:01 +13:00
Krystine Sherwin
fd0c574942
Docs: changes/todos from JF 2024-01-30 13:33:07 +13:00
Krystine Sherwin
9878e69d6c
Docs: tidying
- Use `:file:` role for file names, as well as `:makevar:` and `:program:`.
- Remove deprecated `linux-arm` and `linux-riscv64` oss-cad-suite targets.
- Add link to ABC.
- More (and better) links to code examples.  Formatted `:file:` text with link
  to source on github.
- Includes a few extra todos (mostly picking up inline code blocks and a couple
  intro reminders).
- Fixing a few missing `:yoscrypt:` and `:cmd:ref:` tags.
- Reflowing some paragraphs for spacing/width.
2024-01-30 13:31:00 +13:00
Krystine Sherwin
22808e0e3f
Docs: work on selections.rst
Highlighting the difference between `select prod %ci` and `select prod %ci2` by
introducing `sumproud.out` using the `dump` command.

Playing around with advanced cone example code.
2024-01-26 17:29:59 +13:00
Krystine Sherwin
e2e7065590
Docs: some restructure of advanced section
- Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`.
- To discourage skipping over these index pages, the toctree in
  `using_yosys/index` is hidden and instead has inline links to the two
  subsections.
- Tidying todos.
- Moves technology mapping to `techmap_synth`, leaving the techmap by example in
  the internals section. `yosys_flows` gets split up, with the coarse-grain
  intro replaced by `synthesis/index`, the extract pass moving to
  `synthesis/extract` and model checking to `more_scripting/model_checking`.
2024-01-26 13:08:22 +13:00
Krystine Sherwin
4582ab59da
Docs: intro to memory_libmap 2024-01-26 11:15:01 +13:00
Krystine Sherwin
449135a9d4
Docs: adding other macro command lists
Also updates `macro_commands.py` to skip empty lines, and moves comment
stripping earlier in parsing.
2024-01-24 10:29:40 +13:00
Krystine Sherwin
6c8949cacc
Docs: static opt macro list
Also adds `docs/tests/macro_commands.py` which checks all commands in
`code_examples/macro_commands` against the current yosys build. Format similar
to `run-test.sh` files: logging the file under test and reporting errors.
2024-01-24 09:56:00 +13:00
Krystine Sherwin
95849edbba
Docs: changes from JF
`yosys-witness` prereq `click`.
Yosys environment vars & `yosys --help` output.
Removing Ubuntu/macOS version numbers/names.
Hide `troubleshooting` page.
2024-01-23 17:35:06 +13:00
Krystine Sherwin
14b7c581fa
Docs: reworking scripting_intro
Now comes *after* example_synth, with references back to it.
Includes some minor adjustment to the `fifo.ys` script to better demonstrate the `select` command.
Still needs an updated section on `show`.

Also includes some other minor updates.
2024-01-18 15:33:59 +13:00
Krystine Sherwin
27ae093dba
Docs: working on opt page
Replace leftover `opt` example source/images with examples specific to the `opt_*` pass.
Currently has images for `opt_expr`, `opt_merge`, `opt_muxtree`, and `opt_share`.
Also includes some other TODO updates.
2024-01-17 11:00:42 +13:00
Krystine Sherwin
63a0f80996
Docs: opt_share 2024-01-17 08:47:50 +13:00
Krystine Sherwin
14f2208e47
Docs: opt_expr 2024-01-17 08:40:48 +13:00
Krystine Sherwin
646ff6d32d
Docs: interactive investigation
More `literalinclude` and references to source.
Adding `example_show.ys` and `example_lscd.ys`.
Rename `example_00` et al to `example_first` et al.
Also some other minor tidying.
2024-01-15 15:32:14 +13:00