From: Iris Johnson <iris@modwiz.com>
Date: Wed, 24 Mar 2021 21:24:33 +0000 (-0500)
Subject: Clarify bugpoint documentation regarding output
X-Git-Tag: yosys-0.10~231^2
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=4c39189b137ab3ebcc3db0b5df09c9bf43d97a8c;p=yosys.git

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.
---

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");