Skip to content

Commit 09ead2d

Browse files
tcl: Update help message to clarify usage of result.string
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)
1 parent 3076803 commit 09ead2d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

kernel/yosys.cc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,9 +754,10 @@ struct TclPass : public Pass {
754754
log("If any arguments are specified, these arguments are provided to the script via\n");
755755
log("the standard $argc and $argv variables.\n");
756756
log("\n");
757-
log("Note, tcl will not recieve the output of any yosys command. If the output\n");
757+
log("Note, tcl will not receive the output of any yosys command. If the output\n");
758758
log("of the tcl commands are needed, use the yosys command 'tee -s result.string'\n");
759759
log("to redirect yosys's output to the 'result.string' scratchpad value.\n");
760+
log("The 'result.string' value is then used as the tcl output value of the command.\n");
760761
log("\n");
761762
}
762763
void execute(std::vector<std::string> args, RTLIL::Design *) override {

0 commit comments

Comments
 (0)