3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2026-03-02 23:06:59 +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,4 +1,4 @@
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> Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>

View file

@ -21,7 +21,7 @@ endif
help: help:
@echo "" @echo ""
@echo "sudo make install" @echo "sudo make install"
@echo " build and install SymbiYosys (sby)" @echo " build and install SBY"
@echo "" @echo ""
@echo "make html" @echo "make html"
@echo " build documentation in docs/build/html/" @echo " build documentation in docs/build/html/"

View file

@ -1,10 +1,10 @@
SymbiYosys (sby) is a front-end driver program for [Yosys](https://yosyshq.net/yosys/)-based formal hardware verification flows. See [https://yosyshq.readthedocs.io/projects/sby/](https://yosyshq.readthedocs.io/projects/sby/) for documentation on how to use SymbiYosys. SBY is a front-end driver program for [Yosys](https://yosyshq.net/yosys/)-based formal hardware verification flows. See [https://yosyshq.readthedocs.io/projects/sby/](https://yosyshq.readthedocs.io/projects/sby/) for documentation on how to use SBY.
SymbiYosys (sby) itself is licensed under the ISC license, note that the solvers and other components used by SymbiYosys come with their own license terms. There is some more details in the ["Selecting the right engine" section of the documentation](https://yosyshq.readthedocs.io/projects/sby/en/latest/quickstart.html#selecting-the-right-engine). SBY itself is licensed under the ISC license, note that the solvers and other components used by SBY come with their own license terms. There is some more details in the ["Selecting the right engine" section of the documentation](https://yosyshq.readthedocs.io/projects/sby/en/latest/quickstart.html#selecting-the-right-engine).
--- ---
SymbiYosys (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 dependencies, including all supported solvers. 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 dependencies, including all supported solvers.
* [Contact YosysHQ](https://www.yosyshq.com/contact) for a [Tabby CAD Suite](https://www.yosyshq.com/tabby-cad-datasheet) Evaluation License and download link * [Contact YosysHQ](https://www.yosyshq.com/contact) for a [Tabby CAD Suite](https://www.yosyshq.com/tabby-cad-datasheet) Evaluation License and download link
* OR go to https://github.com/YosysHQ/oss-cad-suite-build/releases to download the free OSS CAD Suite * OR go to https://github.com/YosysHQ/oss-cad-suite-build/releases to download the free OSS CAD Suite

View file

@ -91,9 +91,9 @@ qthelp:
@echo @echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:" ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SymbiYosys.qhcp" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SBY.qhcp"
@echo "To view the help file:" @echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SymbiYosys.qhc" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SBY.qhc"
.PHONY: applehelp .PHONY: applehelp
applehelp: applehelp:
@ -110,8 +110,8 @@ devhelp:
@echo @echo
@echo "Build finished." @echo "Build finished."
@echo "To view the help file:" @echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/SymbiYosys" @echo "# mkdir -p $$HOME/.local/share/devhelp/SBY"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SymbiYosys" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SBY"
@echo "# devhelp" @echo "# devhelp"
.PHONY: epub .PHONY: epub

View file

@ -1,9 +1,9 @@
SymbiYosys (sby) Documentation SBY Documentation
============================== ==============================
SymbiYosys (sby) is a front-end driver program for Yosys-based formal SBY is a front-end driver program for Yosys-based formal
hardware verification flows. SymbiYosys provides flows for the following hardware verification flows. SBY provides flows for the following
formal tasks: formal tasks:
* Bounded verification of safety properties (assertions) * 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) 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://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 <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 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 .. 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> 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 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 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. own license terms.

View file

@ -99,10 +99,10 @@ difference in addresses, and then compare with the count signal.
:end-at: ; :end-at: ;
:dedent: :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. verification.
**basic** **basic**

View file

@ -3,7 +3,7 @@ Formal extensions to Verilog
============================ ============================
Any Verilog file may be read using ``read -formal <file>`` within the 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. line, or various files may be read in subsequent lines.
``read -formal`` will also define the ``FORMAL`` macro, which can be used ``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 SystemVerilog Immediate Assertions
---------------------------------- ----------------------------------
SymbiYosys supports three basic immediate assertion types. SBY supports three basic immediate assertion types.
1. ``assume(<expr>);`` 1. ``assume(<expr>);``
@ -39,15 +39,15 @@ SymbiYosys supports three basic immediate assertion types.
2. ``assert(<expr>);`` 2. ``assert(<expr>);``
An assertion is something the solver will try to make false. Any time 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). 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 ``UNKNOWN`` result if an assertion can be made to fail during the induction
step. step.
3. ``cover(<expr>);`` 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 ``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 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 try to find some clock when ``<expr>`` can be made to be true. Such a

View file

@ -1,6 +1,6 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# SymbiYosys (sby) -- Front-end for Yosys-based formal verification flows # SBY -- Front-end for Yosys-based formal verification flows
# #
# Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one> # Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# SymbiYosys (sby) -- Front-end for Yosys-based formal verification flows # SBY -- Front-end for Yosys-based formal verification flows
# #
# Copyright (C) 2022 N. Engelhardt <nak@yosyshq.com> # Copyright (C) 2022 N. Engelhardt <nak@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# SymbiYosys (sby) -- Front-end for Yosys-based formal verification flows # SBY -- Front-end for Yosys-based formal verification flows
# #
# Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one> # Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# 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> # Copyright (C) 2016 Claire Xenia Wolf <claire@yosyshq.com>
# #

View file

@ -1,5 +1,5 @@
# #
# SymbiYosys (sby) -- Front-end for Yosys-based formal verification flows # SBY -- Front-end for Yosys-based formal verification flows
# #
# Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one> # Copyright (C) 2022 Jannis Harder <jix@yosyshq.com> <me@jix.one>
# #