mirrors/sby
3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-10-31 04:52:30 +00:00
Code Activity

Merge pull request #194 from jix/autotune_rst_fixes

Browse source 
docs: Don't use linebreaks within inline code spans.
This commit is contained in:
Jannis Harder 2022-07-08 14:46:41 +02:00 • committed by GitHub
commit cea760bd52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/source/autotune.rst
View file

@ -11,15 +11,15 @@ Using Autotune
-------------- --------------
To run autotune, you can add the ``--autotune`` option to your usual sby To run autotune, you can add the ``--autotune`` option to your usual sby
invokation. For example if you usually run ``sby demo.sby`` you would run ``sby invokation. For example if you usually run ``sby demo.sby`` you would run
--autotune demo.sby`` instead. When the ``.sby`` file contains multiple tasks, ``sby --autotune demo.sby`` instead. When the ``.sby`` file contains multiple
autotune is run for each task independently. As without ``--autotune``, it is tasks, autotune is run for each task independently. As without ``--autotune``,
possible to specify which tasks to run on the command line. it is possible to specify which tasks to run on the command line.
Autotune runs without requiring further interaction and will eventually print a Autotune runs without requiring further interaction and will eventually print a
list of engine configurations and their respective solving times. To list of engine configurations and their respective solving times. To
permanently use an engine configuration you can copy if from the ``sby permanently use an engine configuration you can copy if from the
--autotune`` output into the ``[engines]`` section of your ``.sby`` file. ``sby --autotune`` output into the ``[engines]`` section of your ``.sby`` file.
Autotune Log Output Autotune Log Output
------------------- -------------------
@ -112,8 +112,8 @@ their solving time:
If any tried engine encounters an error or produces an unexpected result, If any tried engine encounters an error or produces an unexpected result,
autotune will also output a list of failed engines. Note that when the sby file autotune will also output a list of failed engines. Note that when the sby file
does not contain the ``expect`` option, autotune defaults to ``expect does not contain the ``expect`` option, autotune defaults to
pass,fail`` to simplify running autotune on a verification task with a ``expect pass,fail`` to simplify running autotune on a verification task with a
currently unknown outcome. currently unknown outcome.
Configuring Autotune Configuring Autotune