3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-05 14:04:07 +00:00

docs: Cut out the in-progress docs in preperation for a merge

This commit is contained in:
Aki Van Ness 2022-08-05 08:22:55 -04:00
parent 841e0cb797
commit a6c220dd5d
No known key found for this signature in database
GPG key ID: C629E8EC06327BEE
2 changed files with 0 additions and 61 deletions

View file

@ -178,9 +178,6 @@ options are:
| | ``prove``, | specified number of cycles at the end of the trace. |
| | ``cover`` | Default: ``0`` |
+------------------+------------+---------------------------------------------------------+
| ``stage`` | All | The stages to select to run. |
| | | Default: All |
+------------------+------------+---------------------------------------------------------+
Engines section
---------------
@ -209,18 +206,6 @@ In the 2nd line ``abc`` is the engine, there are no engine options, ``sim3`` is
solver, and ``-W 15`` are solver options.
The ``[engines]`` section also takes an argument as to what mode that block applies to.
Meaning you can specify an engine block for a given mode.
Example:
.. code-block:: text
[engines bmc]
btor pono
abc sim3
The following mode/engine/solver combinations are currently supported:
+-----------+--------------------------+
@ -407,47 +392,6 @@ Run ``yosys`` in a terminal window and enter ``help`` on the Yosys prompt
for a command list. Run ``help <command>`` for a detailed description of the
command, for example ``help prep``.
Setup section
-------------
The ``[setup]`` section provides a way to add global cutpoints, and enable/disable/assume/define patterns.
By default properties that are unspecified default to enabled, and a ``disable *`` at the end of the settings
will set the default to be disabled.
For example:
.. code-block:: text
[setup]
enable *
The following options are available for the ``[setup]`` section:
.. todo::
Document better
+------------------+---------------------------------------------------------+
| Option | Description |
+==================+=========================================================+
| ``cutpoint`` | Defines a cutpoint pattern. |
+------------------+---------------------------------------------------------+
| ``disable`` | Defines a disable pattern. |
+------------------+---------------------------------------------------------+
| ``enable`` | Defines an enable pattern. |
+------------------+---------------------------------------------------------+
| ``assume`` | Defines an assume pattern. |
+------------------+---------------------------------------------------------+
| ``define`` | Define a value. |
+------------------+---------------------------------------------------------+
Stage section
-------------
.. todo::
Document
Files section
-------------

View file

@ -945,11 +945,6 @@ class SbyTask(SbyConfig):
with open(f"{self.workdir}/config.sby", "r") as f:
self.parse_config(f)
if len(self.stage) == 0:
self.stage['default'] = {
'enable', '*'
}
self.handle_str_option("mode", None)
if self.opt_mode not in ["bmc", "prove", "cover", "live"]: