From 9beb469ad95bf9d33f719798392f5435db42f38f Mon Sep 17 00:00:00 2001 From: Clifford Wolf Date: Fri, 13 Apr 2018 16:52:56 +0200 Subject: [PATCH] Add documentation on [files] and [file ..] sections Signed-off-by: Clifford Wolf --- docs/source/reference.rst | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/docs/source/reference.rst b/docs/source/reference.rst index 92292c3..6a13e60 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -284,15 +284,46 @@ TBD Files section ------------- -TBD +The files section lists the source files for the proof. ``sby`` copies +these files to ``/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 ``/src/``. + +If the name of the file in ``/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 ------------- -TBD +File sections can be used to create additional files in ``/src/`` from +the literal content of the ``[file ]`` section ("here document"). For +example: + +.. code-block:: text + + [file params.vh] + `define RESET_LEN 42 + `define FAULT_CYCLE 57 Pycode blocks ------------- TBD - -- 2.30.2