Clarify script -scriptwire doc
authorEddie Hung <eddie@fpgeh.com>
Tue, 9 Jul 2019 02:21:21 +0000 (19:21 -0700)
committerEddie Hung <eddie@fpgeh.com>
Tue, 9 Jul 2019 02:21:21 +0000 (19:21 -0700)
kernel/yosys.cc

index f95c0127b8ca5d0589c57a08929e6aa38fddaa81..a42a7c0b8f001154d1a039201af2da312a21d296 100644 (file)
@@ -1273,6 +1273,10 @@ struct ScriptCmdPass : public Pass {
                log("If only one label is specified (without ':') then only the block\n");
                log("marked with that label (until the next label) is executed.\n");
                log("\n");
+               log("In \"-scriptwire\" mode, the commands on the selected wire(s) will be executed\n");
+               log("in the scope of (and thus, relative to) the wires' owning module(s). This\n");
+               log("'-module' mode can be exited by using the 'cd' command.\n");
+               log("\n");
        }
        void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
        {