3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2026-03-02 14:56:57 +00:00

Rename SymbiYosys to SBY

This commit is contained in:
Gus Smith 2026-02-24 09:03:49 -08:00
parent 4dabe8ab32
commit b4e66e3a33
23 changed files with 38 additions and 38 deletions

View file

@ -1,9 +1,9 @@
SymbiYosys (sby) Documentation
SBY Documentation
==============================
SymbiYosys (sby) is a front-end driver program for Yosys-based formal
hardware verification flows. SymbiYosys provides flows for the following
SBY is a front-end driver program for Yosys-based formal
hardware verification flows. SBY provides flows for the following
formal tasks:
* Bounded verification of safety properties (assertions)

View file

@ -8,7 +8,7 @@ This document will guide you through the process of installing sby.
CAD suite(s)
************
Sby (SymbiYosys) is part of the `Tabby CAD Suite
Sby (SBY) is part of the `Tabby CAD Suite
<https://www.yosyshq.com/tabby-cad-datasheet>`_ and the `OSS CAD Suite
<https://github.com/YosysHQ/oss-cad-suite-build>`_! The easiest way to use sby
is to install the binary software suite, which contains all required

View file

@ -1,12 +1,12 @@
SymbiYosys license
SBY license
==================
SymbiYosys (sby) itself is licensed under the ISC license:
SBY itself is licensed under the ISC license:
.. code-block:: text
SymbiYosys (sby) -- Front-end for Yosys-based formal verification flows
SBY -- Front-end for Yosys-based formal verification flows
Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
@ -22,6 +22,6 @@ SymbiYosys (sby) itself is licensed under the ISC license:
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Note that the solvers and other components used by SymbiYosys come with their
Note that the solvers and other components used by SBY come with their
own license terms.

View file

@ -99,10 +99,10 @@ difference in addresses, and then compare with the count signal.
:end-at: ;
:dedent:
SymbiYosys
SBY
**********
SymbiYosys (sby) uses a .sby file to define a set of tasks used for
SBY uses a .sby file to define a set of tasks used for
verification.
**basic**

View file

@ -3,7 +3,7 @@ Formal extensions to Verilog
============================
Any Verilog file may be read using ``read -formal <file>`` within the
SymbiYosys ``script`` section. Multiple files may be given on the sames
SBY ``script`` section. Multiple files may be given on the sames
line, or various files may be read in subsequent lines.
``read -formal`` will also define the ``FORMAL`` macro, which can be used
@ -28,7 +28,7 @@ example above. Refer to :doc:`verific` for more on the Verific front end.
SystemVerilog Immediate Assertions
----------------------------------
SymbiYosys supports three basic immediate assertion types.
SBY supports three basic immediate assertion types.
1. ``assume(<expr>);``
@ -39,15 +39,15 @@ SymbiYosys supports three basic immediate assertion types.
2. ``assert(<expr>);``
An assertion is something the solver will try to make false. Any time
SymbiYosys is run with ``mode bmc``, the proof will fail if some set
SBY is run with ``mode bmc``, the proof will fail if some set
of inputs can cause the ``<expr>`` within the assertion to be zero (false).
When SymbiYosys is run with ``mode prove``, the proof may also yield an
When SBY is run with ``mode prove``, the proof may also yield an
``UNKNOWN`` result if an assertion can be made to fail during the induction
step.
3. ``cover(<expr>);``
A cover statement only applies when SymbiYosys is ran with option
A cover statement only applies when SBY is ran with option
``mode cover``. In this case, the formal solver will start at the
beginning of time (i.e. when all initial statements are true), and it will
try to find some clock when ``<expr>`` can be made to be true. Such a