From 7ff783598f5032fe34d78e9569b8c25b3e39645b Mon Sep 17 00:00:00 2001 From: Clifford Wolf Date: Thu, 6 Sep 2018 19:36:25 +0200 Subject: [PATCH] Update docs Signed-off-by: Clifford Wolf --- docs/source/reference.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/source/reference.rst b/docs/source/reference.rst index 9ef84c1..9d2871c 100644 --- a/docs/source/reference.rst +++ b/docs/source/reference.rst @@ -315,8 +315,14 @@ command, for example ``help prep``. Files section ------------- -The files section lists the source files for the proof. ``sby`` copies -these files to ``/src/`` before running the Yosys script. +The files section lists the source files for the proof, meaning all the +files Yosys will need to access when reading the design, including for +example data files for ``$readmemh`` and ``$readmemb``. + +``sby`` copies these files to ``/src/`` before running the Yosys +script. When the Yosys script is executed, it will use the copies in +``/src/``. (Alternatively absolute filenames can be used in the +Yosys script for files not listed in the files section.) For example: @@ -339,7 +345,7 @@ the source file name. For example: [files] top.sv defines.vh ../common/defines_footest.vh - /data/prj42/modules/foobar.sv + foo/bar.sv /data/prj42/modules/foobar.sv File sections ------------- -- 2.30.2