diff options
author | Eddie Hung <eddie@fpgeh.com> | 2020-04-23 12:16:55 -0700 |
---|---|---|
committer | Eddie Hung <eddie@fpgeh.com> | 2020-04-23 12:16:55 -0700 |
commit | bf021a0e1f0883c017242d4a2057d2acf239330b (patch) | |
tree | 7d501a9fd3f4eeb6a025752b9ffe327ecd912d81 /passes/cmds/bugpoint.cc | |
parent | b048afc3a60984d10da7e4618236b957dab527a8 (diff) | |
download | yosys-bf021a0e1f0883c017242d4a2057d2acf239330b.tar.gz yosys-bf021a0e1f0883c017242d4a2057d2acf239330b.tar.bz2 yosys-bf021a0e1f0883c017242d4a2057d2acf239330b.zip |
bugpoint: improve help text
Diffstat (limited to 'passes/cmds/bugpoint.cc')
-rw-r--r-- | passes/cmds/bugpoint.cc | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/passes/cmds/bugpoint.cc b/passes/cmds/bugpoint.cc index a75927393..4668da4bd 100644 --- a/passes/cmds/bugpoint.cc +++ b/passes/cmds/bugpoint.cc @@ -30,23 +30,21 @@ struct BugpointPass : public Pass { { // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---| log("\n"); - log(" bugpoint [options]\n"); + log(" bugpoint [options] -script <filename>\n"); log("\n"); - log("This command minimizes testcases that crash Yosys. It removes an arbitrary part\n"); - log("of the design and recursively invokes Yosys with a given script, repeating these\n"); - log("steps while it can find a smaller design that still causes a crash. Once this\n"); - log("command finishes, it replaces the current design with the smallest testcase it\n"); - log("was able to produce.\n"); + log("This command minimizes the current design that is known to crash Yosys with the\n"); + log("given script into a smaller testcase. It does this by removing an arbitrary part\n"); + log("of the design and recursively invokes a new Yosys process with this modified design\n"); + 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("\n"); - log("It is possible to specify the kinds of design part that will be removed. If none\n"); - log("are specified, all parts of design will be removed.\n"); + log(" -script <filename>\n"); + log(" use this script to crash Yosys. required.\n"); log("\n"); log(" -yosys <filename>\n"); log(" use this Yosys binary. if not specified, `yosys` is used.\n"); log("\n"); - log(" -script <filename>\n"); - log(" use this script to crash Yosys. required.\n"); - log("\n"); log(" -grep <string>\n"); log(" only consider crashes that place this string in the log file.\n"); log("\n"); @@ -60,6 +58,10 @@ struct BugpointPass : public Pass { log(" finishing. produces smaller and more useful testcases, but may fail to\n"); log(" produce any testcase at all if the crash is related to dangling wires.\n"); log("\n"); + log("It is possible to constrain which parts of the design will be considered for\n"); + log("removal. Unless one or more of the following options are specified, all parts\n"); + log("will be considered.\n"); + log("\n"); log(" -modules\n"); log(" try to remove modules.\n"); log("\n"); |