3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2026-02-02 07:16:19 +00:00
Commit graph

16147 commits

Author SHA1 Message Date
Krystine Sherwin
af93a0cfc9
Docs: Initial split of documenting.rst
Moving details about how the docs are built into a separate doc, allowing `documenting.rst` to focus on guidance for how to document passes/cells (and what the help text should contain).
Also puts cell help v2 and `Pass::formatted_help` as the primary means of providing help text, with the older styles being pseudo deprecated (or at least depreciated), reframing them as the more limited original methods rather than the default (despite functionally being that).
Still very much WIP.
2026-01-30 17:40:46 +13:00
Krystine Sherwin
0b41bdab66
documenting.rst: Negatives are hard 2026-01-30 12:24:21 +13:00
Krystine Sherwin
069f6ef348
Docs: Fix cell option_spec inheritance
Doesn't actually resolve the `:noindex:` failure, which is how I discovered the option wasn't being inherited, but it is a step in the right direction.
2025-11-22 15:39:22 +13:00
Krystine Sherwin
39e3e39241
documenting.rst: Our custom Sphinx domains 2025-11-22 15:36:59 +13:00
Krystine Sherwin
dc8198561a
documenting.rst: Using autodoc
Switch `autocmd` to use the `seealso` admonition for referencing source file location instead of `note`.
2025-11-22 12:56:30 +13:00
Krystine Sherwin
5318df784a
contributing.rst: Reference documenting.rst for help text 2025-11-22 10:04:53 +13:00
Krystine Sherwin
56c1ef2679
documenting.rst: Finished cells and starting on Sphinx
Use an external file to demonstrate the `autoref` role (the external file lets us `literalinclude` and `include` without writing out the source twice, while still showing all the different ways of using our custom roles).
2025-11-21 17:52:54 +13:00
Krystine Sherwin
da65409d69
documenting.rst: Cell help v1 and v2
Also a (commented) mention of v2a for the extra curious.
2025-11-21 12:30:54 +13:00
Krystine Sherwin
fc88002266
cellhelp.py: Unify manual signature handling
Both files strip it, but previously the exact check differed.  It is also now safer, checking the length before trying to access elements by index.
2025-11-21 12:29:44 +13:00
Krystine Sherwin
bb8ef02e85
docs: Intro to cell help
Allow autoref to render `help *` as yoscrypt instead of trying to link when `*` starts with `<` or `-`, as in `help <command>` and `help -all`.
Fix autoref `help *` being linkable when there is a line break in the middle.
2025-11-19 14:29:13 +13:00
Krystine Sherwin
784c73ad38
documenting.rst: Warning flags
Add `test_generic.cc` to docs gen, and rename `docs/gen/chformal` to the more generic `docs/gen/raw_commands` (in line with `docs/gen/raw_cells`).
2025-11-18 15:33:13 +13:00
Krystine Sherwin
695bace331
log_help.cc: Don't re-flow codeblocks
Move to a (single) `log_content_body()` instead of the dual `log_pass_str()` (nothing used the string-based indent arg), and pass the `ContentListing` directly; printing codeblocks verbatim (with indent).
Refactor (non-codeblock) line splitting slightly so that it can print up to and including 80 characters before the line break.
Add comments.
2025-11-18 14:12:27 +13:00
Krystine Sherwin
657b0bd92b
documenting.rst: literalinclude cell doc examples
Add a sed command to the (top level) makefile for extract comment block for the specified cell.  Works with both simlib.v and simcells.v (by abusing `%` pattern matching slightly to disambiguate which to search).
2025-11-18 12:20:33 +13:00
Krystine Sherwin
f2a80e4d7f
register.cc: Tidying
Use `yosys_maybe_version()` in `dump_cmds_json()`.
Replace `&it` with `&[name, pass]`.
Add a space when folding indented lines into usage signature.
2025-11-17 18:51:01 +13:00
Krystine Sherwin
4eff547f6f
documenting.rst: Dumping to JSON
Split into cmd/cell sections.  cmd json is in paragraphs, cell json is bullet points (and pending example).
Add (bullet point) section for warning flags.
Add note to `Pass::help()` about how each line should be a single `log()` call.
2025-11-17 18:49:07 +13:00
Krystine Sherwin
5896579066
log_help.cc: Better line splitting
If a word by itself meets the max line length it should only drop to a new line if the current line has content (would previously force an empty line before it).
Include the length of indent when adding a line break (was previously only accounted for on the first line).
2025-11-17 12:47:50 +13:00
Krystine Sherwin
e5b9401bf3
documenting.rst: Command line rendering 2025-11-17 12:44:41 +13:00
Krystine Sherwin
966f52e123
documenting.rst: More json/sphinx bullets
Also moved them to the bottom, instead of being under the "command help" heading.
Now includes more info about cells, and the custom sphinx domains/directives/roles we have.
2025-11-15 16:06:09 +13:00
Krystine Sherwin
0a6ce3d820
documenting.rst: formatted_help 2025-11-15 11:54:42 +13:00
Krystine Sherwin
1186ca8f68
documenting.rst: WIP paragraphs
First couple sections done, plus a couple formatting tidy ups later on.
2025-11-14 18:10:34 +13:00
Krystine Sherwin
625eae987f
log_help.cc: Fix source_location on option 2025-11-14 14:31:28 +13:00
Krystine Sherwin
2da7627491
docs: Move help guides to documenting.rst 2025-11-14 14:21:59 +13:00
Krystine Sherwin
b9182ab8b7
Update checklist for adding internal cell types
Add line about v2 cell help
Update docs path to point to the right place
2025-11-14 13:37:02 +13:00
Krystine Sherwin
25822be930
docs: Initial documentation for generated help
Very briefly on command help
Mostly focused on v1 and v2 of the cell help, but still largely bullet points
2025-11-14 13:37:02 +13:00
github-actions[bot]
5d0847f6fb Bump version 2025-11-07 00:24:35 +00:00
KrystalDelusion
24b69cabaa
Merge pull request #5422 from YosysHQ/krys/SVI_support
Catch partial support of SVI
2025-11-07 11:16:07 +13:00
Miodrag Milanović
691d6b8508
Merge pull request #5469 from YosysHQ/update_abc
Update ABC
2025-11-06 21:19:39 +01:00
Emil J
a16fc9b4f3
Merge pull request #5467 from YosysHQ/emil/liberty-unquoted-expressions
libparse: support unquoted expressions
2025-11-06 19:45:17 +01:00
Emil J
3a23d4458e
Merge pull request #5470 from YosysHQ/emil/unit-test-makefile
Makefile: clean unit test on clean, ensure prepared to fix parallelism
2025-11-06 19:05:57 +01:00
Miodrag Milanovic
dc9a787025 Fix out of tree clean 2025-11-06 14:28:28 +01:00
Emil J. Tywoniak
2bf7aac9d1 Makefile: clean unit test on clean, ensure prepared to fix parallelism 2025-11-06 13:59:14 +01:00
Emil J. Tywoniak
fdcc4c1507 libparse: remove leftover comments 2025-11-06 13:30:09 +01:00
Emil J
a2aeef6c96
Merge pull request #5461 from rocallahan/reset-abc-config
Fix regression in configuring ABC techmapping
2025-11-06 11:58:04 +01:00
Miodrag Milanovic
75ce33c7b2 Update ABC 2025-11-06 09:54:47 +01:00
github-actions[bot]
3d5b1e0a93 Bump version 2025-11-06 00:24:21 +00:00
Miodrag Milanović
5b2252ffd8
Merge pull request #5468 from YosysHQ/pyosys_outof
Fix generatory.py location for out of tree builds
2025-11-05 18:13:14 +01:00
Robert O'Callahan
0f770285f3 Move global ABC configuration variables into AbcConfig and initialize them properly 2025-11-05 13:56:04 +00:00
Martin Povišer
45bb5c690d
Merge pull request #5460 from povik/timeest-comb
timeest: Add top ports launching/sampling
2025-11-05 14:29:34 +01:00
Miodrag Milanovic
f8341affe3 Fix generatory.py location for out of tree builds 2025-11-05 14:20:30 +01:00
Emil J. Tywoniak
90553267b0 libparse: fix quoting and negedge in filterlib -verilogsim 2025-11-05 14:13:58 +01:00
Emil J. Tywoniak
504b668ea6 libparse: fix verilogsim negedge 2025-11-05 13:49:05 +01:00
Emil J. Tywoniak
b0a3d6a3e7 libparse: fix up tests since liberty expression parsing now normalizes the form of these expressions 2025-11-05 13:06:12 +01:00
Emil J. Tywoniak
bf29f6dc11 libparse: tolerate closing quotes in expression parsing 2025-11-05 13:06:09 +01:00
Emil J. Tywoniak
4fac7a1b20 libparse: fix space before closing paren in expressions 2025-11-05 13:05:56 +01:00
Emil J. Tywoniak
547e254a9b libparse: parse expressions in filterlib 2025-11-05 13:05:56 +01:00
Emil J. Tywoniak
66d8fc5c28 libparse: quirk-compatibility for unquoted boolean expression strings 2025-11-05 11:00:25 +01:00
Miodrag Milanovic
e89c5914fe CodeQL CI fix 2025-11-05 07:10:08 +01:00
github-actions[bot]
12cb8e9511 Bump version 2025-11-05 00:24:49 +00:00
KrystalDelusion
52c108cd6a
Merge pull request #4596 from YosysHQ/emil/path-sep-refactor
Refactor getting dirs and filenames from paths to files
2025-11-05 09:12:54 +13:00
Miodrag Milanović
3d80e1663e
Merge pull request #5466 from donn/uv_wheel_hotfix
hotfix: wheel ci issues
2025-11-04 14:09:41 +01:00