3
0
Fork 0
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:
Krystine Sherwin 2026-05-05 17:51:49 +12:00
parent 1a27ba7b1b
commit ec27ee9627
No known key found for this signature in database
3 changed files with 68 additions and 0 deletions

View file

@ -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