From ec2f8796bd7a5180f257a92d7ffb2029571cada6 Mon Sep 17 00:00:00 2001
From: rockybulwinkle <rockybulwinkle@gmail.com>
Date: Thu, 23 Jun 2022 13:34:08 -0500
Subject: [PATCH] Update tcl doc, yosys does not return data to tcl
This pull request is to address YosysHQ/yosys#2980.
The documentation, as originally written, does not make it clear that yosys commands, when used within a tcl script, do not return any value to the tcl script.
This pull request notes this and offers a workaround via tee as noted in the issue.
---
kernel/yosys.cc | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/kernel/yosys.cc b/kernel/yosys.cc
index 64d2b4def..521717ce7 100644
--- a/kernel/yosys.cc
+++ b/kernel/yosys.cc
@@ -773,6 +773,12 @@ struct TclPass : public Pass {
log("\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("\n");
+ log("Note, tcl will not recieve the output of any yosys command. If the output\n");
+ log("of the tcl commands are needed, use the yosys command 'tee' to redirect yosys's\n");
+ log("output to a temporary file.\n");
+
+
log("\n");
}
void execute(std::vector<std::string> args, RTLIL::Design *) override {