Krystine Sherwin
974c2339d9
Docs: Add default tasks and alt tag assignment
...
Demonstrate `--dumpcfg` sans task in the complex code example (and how the empty task impacts tag matching).
2026-05-06 09:07:32 +12:00
Krystine Sherwin
1a27ba7b1b
Docs: Advanced tag use
...
Add complex pycode example, generating tasks and then parsing tags to select source files. Warn against doing it, and reiterate the usefulness of `--dumptasks` and `--dumpcfg`.
Modify gen.sh for modifiable script/task and to echo how it was called (in case they need to be regenerated, which isn't a problem for the regular example/task1 but is for the complex one).
2026-05-05 17:50:49 +12:00
Krystine Sherwin
b476597edf
Docs: Clarify tasks section
...
Move simple tasks example into an actual `.sby` file and use `literalinclude`.
Add `gen.sh` script for generating output log (currently using checked in log file so that we don't need to deal with having sby installed for readthedocs).
Remove more complex examples.
Remove "group aliases" in favor of "tags".
Refer to `<tag>:` instead of `<taskname>:`.
Introduce `--dumptags` and tasks being assigned a tag of the same name.
Split out tags into subsection.
Move "run specific task" example call in line, and add a task (so that it shows two tasks in one)
2026-05-05 17:02:44 +12:00
inquisitour
7225ad24f1
itp engine: address review feedback - simplify arg parsing, fix status logic, use exe_paths
2026-03-14 18:07:04 +00:00
inquisitour
39670d6611
Add ITP engine: interpolation-based model checking via itp-bmc
2026-02-28 07:11:08 +00:00
nella
a6746d0b58
Cleanup docs.
2026-02-18 09:35:17 +01:00
nella
b153c8e080
document abc --keep-going pdr [sc-220]
2026-02-11 11:33:10 +01:00
N. Engelhardt
1a44b87d9a
fix whitespace in docs options table
2025-11-19 09:22:00 +01:00
Jannis Harder
6d0a1ed960
Add cycle_width option for sim's new -width option
2025-10-20 17:30:09 +02:00
Krystine Sherwin
9589ce203a
Document cancelledby section
2025-07-09 10:05:36 +12:00
KrystalDelusion
562a504709
Docs fix
2025-07-07 20:07:25 +12:00
Krystine Sherwin
4d8462b58e
Add cover_assert option
2025-07-05 11:17:05 +12:00
Yuheng Su
daf4e4cb39
Support rIC3 as backend
...
Signed-off-by: Yuheng Su <gipsyh.icu@gmail.com>
2024-12-16 11:02:45 +00:00
Jannis Harder
62d17081bf
Merge pull request #276 from YosysHQ/krys/test-furo-ys
...
Use furo-ys
2024-09-27 14:21:07 +02:00
George Rennie
07b9b7cbb8
docs: fix reference to aigbmc engine option
2024-08-01 17:34:54 +01:00
Krystine Sherwin
0fab912005
Docs: Use sby role shortcut
2024-06-10 18:46:31 +12:00
Krystine Sherwin
a3844d4a30
Docs: Use sby lexer
2024-06-10 18:41:15 +12:00
Jannis Harder
c5dce57067
append_assume: Make append_assume on the default for now
...
Having `append_assume off` needs `vcd_sim on` to not be ignored with a
warning and `vcd_sim off` is still the default.
2023-02-08 14:18:52 +01:00
Jannis Harder
7a3b88ca67
docs: Document new sim related options
2023-02-06 16:55:19 +01:00
Jannis Harder
168d667b6d
Add vcd option to make VCD writing optional
2022-09-05 15:42:24 +02:00
Aki Van Ness
e8b8816143
docs: removed empty line
2022-08-18 05:36:11 -04:00
Aki Van Ness
a6c220dd5d
docs: Cut out the in-progress docs in preperation for a merge
2022-08-18 05:36:11 -04:00
Aki Van Ness
da56a3c6d1
docs: started working on a rough draft of the docs for the new sections and changes to existing sections
2022-08-18 05:36:11 -04:00
Jannis Harder
3412ea859b
New "none" engine to be used with the "make_model" option
2022-08-05 16:31:15 +02:00
Jannis Harder
231f0b80aa
Add make_model option to generate models not required by the task
...
Useful to do custom things (like counter example minimization) but still
use sby's flow to prepare models.
2022-08-05 16:31:15 +02:00
Jannis Harder
d8ebd1eb9d
Reflect recent engine updates in the reference docs
2022-06-20 15:23:59 +02:00
N. Engelhardt
3834fe7622
document btor engine, add overview of mode/engine/solver combinations, remove unimplemented modes
2022-03-25 18:01:09 +01:00
Clifford Wolf
cef50242df
Add --dumptasks to documentation
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2019-03-08 12:20:08 -08:00
Clifford Wolf
d5fa89ee0c
Improve sby file pycode/tasks handling
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2019-03-08 10:58:28 -08:00
Clifford Wolf
4eb91d5b88
Add "smtbmc ... -- ..." feature (for "raw" smtbmc options)
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-11-22 17:08:28 +01:00
Clifford Wolf
bf47da495b
Add "skip" options (smtbmc only)
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-09-12 13:23:34 +02:00
Clifford Wolf
7ff783598f
Update docs
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-09-06 19:36:25 +02:00
Clifford Wolf
93e7e1d1e2
Improve documentation of scripts and Verific bindings
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-06-23 18:25:52 +02:00
Clifford Wolf
437a401739
Add [script] documentation, add some paragraphs on "verific" command
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-04-18 19:32:58 +02:00
Clifford Wolf
f0bf0c155a
Typo fix
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-04-13 18:10:22 +02:00
Clifford Wolf
9beb469ad9
Add documentation on [files] and [file ..] sections
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-04-13 16:52:56 +02:00
Clifford Wolf
47729cd61c
Add smtbmc --progress option
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-07 22:16:24 +01:00
Clifford Wolf
f6ab848797
Improvements in [tasks] handling
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-06 18:05:51 +01:00
Clifford Wolf
d736fb14f9
Slightly change tasks syntax
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-06 00:01:55 +01:00
Clifford Wolf
231d06b7c5
Add documentation for [tasks] section
2018-03-05 13:09:40 +01:00
Clifford Wolf
a94f21abab
Add multiclock option
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-04 14:09:16 +01:00
Clifford Wolf
e966f3dca4
Add smtbmc --stdt option
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-04 14:08:55 +01:00
Clifford Wolf
23a369e16d
Add engines documentation
...
Signed-off-by: Clifford Wolf <clifford@clifford.at>
2018-03-03 15:54:00 +01:00
Clifford Wolf
6ef12a4b31
Add tbtop config option
2017-07-01 18:33:36 +02:00
Clifford Wolf
ff054ab88b
Add support for "aigsmt none" option
2017-05-28 12:32:03 +02:00
Clifford Wolf
a2c1dd3f91
Yices 2 is the new default solver for yosys-smtbmc
2017-05-27 12:04:43 +02:00
Clifford Wolf
7fdbb4c179
Update docs
2017-03-01 11:12:30 +01:00
Clifford Wolf
29968fcc58
Add docs for "wait" option, more config checking
2017-02-06 21:50:57 +01:00
Clifford Wolf
24e19e3cda
Update docs
2017-02-06 17:49:20 +01:00
Clifford Wolf
3a13b116a6
Initial import
2017-01-22 16:47:47 +01:00
