Merge pull request #4868 from david-sawatzke/improve_tcl_output_docs

tcl: Update help message to clarify usage of `result.string`
This commit is contained in:
N. Engelhardt 2025-03-03 15:16:42 +00:00 committed by GitHub
commit 0dfd9e9395
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions

View File

@ -757,9 +757,10 @@ struct TclPass : public Pass {
log("If any arguments are specified, these arguments are provided to the script via\n"); log("If any arguments are specified, these arguments are provided to the script via\n");
log("the standard $argc and $argv variables.\n"); log("the standard $argc and $argv variables.\n");
log("\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("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("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"); log("\n");
} }
void execute(std::vector<std::string> args, RTLIL::Design *) override { void execute(std::vector<std::string> args, RTLIL::Design *) override {