aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIris Johnson <iris@modwiz.com>2021-03-24 16:24:33 -0500
committerGitHub <noreply@github.com>2021-03-24 16:24:33 -0500
commit4c39189b137ab3ebcc3db0b5df09c9bf43d97a8c (patch)
treedabe9d52de6e8f046bf2a57f858ceb26c281c4a8
parentc58bb1d2e1e7ff3181c7b5d4d0a0d10d95d3b6fe (diff)
downloadyosys-4c39189b137ab3ebcc3db0b5df09c9bf43d97a8c.tar.gz
yosys-4c39189b137ab3ebcc3db0b5df09c9bf43d97a8c.tar.bz2
yosys-4c39189b137ab3ebcc3db0b5df09c9bf43d97a8c.zip
Clarify bugpoint documentation regarding output
Bugpoint's current documentation does specify that the result of a run is stored as the current design, however it's easy to skim over what that means in practice. Add a documentation comment to explain specifically that an after bugpoint `write_xyz` pass is required to save the reduced design.
-rw-r--r--passes/cmds/bugpoint.cc2
1 files changed, 2 insertions, 0 deletions
diff --git a/passes/cmds/bugpoint.cc b/passes/cmds/bugpoint.cc
index 70c002c44..c782d9a38 100644
--- a/passes/cmds/bugpoint.cc
+++ b/passes/cmds/bugpoint.cc
@@ -38,6 +38,8 @@ struct BugpointPass : public Pass {
log("and the same script, repeating these steps while it can find a smaller design that\n");
log("still causes a crash. Once this command finishes, it replaces the current design\n");
log("with the smallest testcase it was able to produce.\n");
+ log("In order to save the reduced testcase you must write this out to a file with\n");
+ log("another command after `bugpoint` like `write_rtlil` or `write_verilog`.\n");
log("\n");
log(" -script <filename> | -command \"<command>\"\n");
log(" use this script file or command to crash Yosys. required.\n");