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)
This commit is contained in:
David Sawatzke 2025-01-28 09:42:39 +01:00
parent 3076803c9e
commit 09ead2daa9
1 changed files with 2 additions and 1 deletions

View File

@ -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 {