diff options
author | rockybulwinkle <rockybulwinkle@gmail.com> | 2022-06-23 13:34:08 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-23 13:34:08 -0500 |
commit | ec2f8796bd7a5180f257a92d7ffb2029571cada6 (patch) | |
tree | de9c5ff174b2f200ba9146233982256522c08a0a /kernel | |
parent | b2408df31332cdf810bc9831ae3aface1048652c (diff) | |
download | yosys-ec2f8796bd7a5180f257a92d7ffb2029571cada6.tar.gz yosys-ec2f8796bd7a5180f257a92d7ffb2029571cada6.tar.bz2 yosys-ec2f8796bd7a5180f257a92d7ffb2029571cada6.zip |
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.
Diffstat (limited to 'kernel')
-rw-r--r-- | kernel/yosys.cc | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/kernel/yosys.cc b/kernel/yosys.cc index 64d2b4def..521717ce7 100644 --- a/kernel/yosys.cc +++ b/kernel/yosys.cc @@ -774,6 +774,12 @@ 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("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 { if (args.size() < 2) |