Skip to content

Commit

Permalink
tcl: Update help message to clarify usage of result.string
Browse files Browse the repository at this point in the history
In the current documentation, it's unclear if `result.string` serves as
an example of a string name. It is furthermore unclear what the purpose
of `result.string` is. Clarify this by adding a small explanation (and
fix a typo)
  • Loading branch information
david-sawatzke committed Jan 28, 2025
1 parent 3076803 commit 09ead2d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion kernel/yosys.cc
Original file line number Diff line number Diff line change
Expand Up @@ -754,9 +754,10 @@ struct TclPass : public Pass {
log("If any arguments are specified, these arguments are provided to the script via\n");
log("the standard $argc and $argv variables.\n");
log("\n");
log("Note, tcl will not recieve the output of any yosys command. If the output\n");
log("Note, tcl will not receive the output of any yosys command. If the output\n");
log("of the tcl commands are needed, use the yosys command 'tee -s result.string'\n");
log("to redirect yosys's output to the 'result.string' scratchpad value.\n");
log("The 'result.string' value is then used as the tcl output value of the command.\n");
log("\n");
}
void execute(std::vector<std::string> args, RTLIL::Design *) override {
Expand Down

0 comments on commit 09ead2d

Please sign in to comment.