mirror of
https://github.com/YosysHQ/sby.git
synced 2026-05-10 14:32:27 +00:00
Docs: Multi-line tag sections
This commit is contained in:
parent
1a27ba7b1b
commit
ec27ee9627
3 changed files with 68 additions and 0 deletions
20
docs/examples/tags/bad.log
Normal file
20
docs/examples/tags/bad.log
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
./gen.sh -s bad
|
||||
$ sby --dumptasks bad.sby
|
||||
task1
|
||||
task2
|
||||
task3
|
||||
$ sby --dumptags bad.sby
|
||||
task1
|
||||
task2
|
||||
task3
|
||||
task_1_or_2
|
||||
task_1_or_3
|
||||
$ sby --dumptags bad.sby task1
|
||||
task1
|
||||
task_1_or_2
|
||||
task_1_or_3
|
||||
$ sby --dumpcfg bad.sby task1
|
||||
[options]
|
||||
mode bmc
|
||||
depth 100
|
||||
|
||||
15
docs/examples/tags/bad.sby
Normal file
15
docs/examples/tags/bad.sby
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
[tasks]
|
||||
task1 task_1_or_2 task_1_or_3
|
||||
task2 task_1_or_2
|
||||
task3 task_1_or_3
|
||||
|
||||
[options]
|
||||
task_1_or_2:
|
||||
mode bmc
|
||||
depth 100
|
||||
|
||||
task3:
|
||||
mode prove
|
||||
|
||||
[engines]
|
||||
...
|
||||
|
|
@ -1,6 +1,39 @@
|
|||
Tasks and tags
|
||||
==============
|
||||
|
||||
Multi-line tag sections
|
||||
-----------------------
|
||||
If ``<tag>:`` is used on a line by itself then the conditional string
|
||||
extends until ``--`` is found on a line by itself.
|
||||
|
||||
.. code-block:: sby
|
||||
|
||||
[options]
|
||||
task_1_or_2:
|
||||
mode bmc
|
||||
depth 100
|
||||
--
|
||||
|
||||
task3:
|
||||
mode prove
|
||||
--
|
||||
|
||||
If the closing ``--`` line is ommitted, the current conditional block will
|
||||
extend until the next conditional block. However it is recommended to always
|
||||
include the closing ``--`` line to avoid inadvertently making the rest of the
|
||||
file conditional.
|
||||
|
||||
.. literalinclude:: /../examples/tags/bad.sby
|
||||
:language: sby
|
||||
:start-at: [options]
|
||||
:caption: ``bad.sby``
|
||||
|
||||
.. literalinclude:: /../examples/tags/bad.log
|
||||
:language: console
|
||||
:start-at: dumpcfg
|
||||
:caption: ``[engines]`` section is only enabled for ``task3``
|
||||
|
||||
|
||||
Complex pycode blocks
|
||||
---------------------
|
||||
The following example demonstrates how to configure safety and liveness checks
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue