Skip to content

Commit b4cef7c

Browse files
committed
Clarify docs on check script arguments
Clarify docs on check script arguments in case of multi-file minimization Fixes #16
1 parent 6fd986d commit b4cef7c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ to your path, as some scripts may depend on each other.
3636
## Usage
3737

3838
First, you need to prepare:
39-
- a script that takes the path to a SystemVerilog file as the first argument and asserts that the same bug (or another property you wish to preserve) is still occurring.
39+
- a script that takes one or more paths to SystemVerilog files as command-line arguments and asserts that the same bug (or another property you wish to preserve) is still occurring.
4040
It should exit with 0 if the assertion is successful.
4141
For reference, see [`examples/caliptra_verilation_err/sv-bugpoint-check.sh`](examples/caliptra_verilation_err/sv-bugpoint-check.sh) and [`examples/caliptra_vcd/sv-bugpoint-check.sh`](examples/caliptra_vcd/sv-bugpoint-check.sh).
4242
The script can be written in any language you are comfortable with, it just needs to be an executable. See the Python example: [`examples/caliptra_verilation_err/sv-bugpoint-check.py`](examples/caliptra_verilation_err/sv-bugpoint-check.py).

0 commit comments

Comments
 (0)