From 09ead2daa90a92236f162ef8a9612a740439393e Mon Sep 17 00:00:00 2001 From: David Sawatzke Date: Tue, 28 Jan 2025 09:42:39 +0100 Subject: [PATCH] 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) --- kernel/yosys.cc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/kernel/yosys.cc b/kernel/yosys.cc index de25d20e2..4bccb1f14 100644 --- a/kernel/yosys.cc +++ b/kernel/yosys.cc @@ -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 args, RTLIL::Design *) override {