mirrors/sby
3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-05 22:14:08 +00:00
Code Activity

Add documentation on [files] and [file ..] sections

Browse source 
Signed-off-by: Clifford Wolf <clifford@clifford.at>
This commit is contained in:
Clifford Wolf 2018-04-13 16:52:56 +02:00
parent fc7ace7884
commit 9beb469ad9
1 changed files with 34 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/source/reference.rst
View file

@ -284,15 +284,46 @@ TBD
Files section Files section
------------- -------------
TBD The files section lists the source files for the proof. ``sby`` copies
these files to ``<outdir>/src/`` before running the Yosys script.
For example:
.. code-block:: text
[engines]
top.sv
../common/defines.vh
/data/prj42/modules/foobar.sv
Will copy these files as ``top.v``, ``defines.vh``, and ``foobar.sv``
to ``<outdir>/src/``.
If the name of the file in ``<outdir>/src/`` should be different from the
basename of the specified file, then the new file name can be specified before
the source file name. For example:
.. code-block:: text
[engines]
top.sv
defines.vh ../common/defines_footest.vh
/data/prj42/modules/foobar.sv
File sections File sections
------------- -------------
TBD File sections can be used to create additional files in ``<outdir>/src/`` from
the literal content of the ``[file <filename>]`` section ("here document"). For
example:
.. code-block:: text
[file params.vh]
`define RESET_LEN 42
`define FAULT_CYCLE 57
Pycode blocks Pycode blocks
------------- -------------
TBD TBD