Update show pass documentation with Windows caveats.
authorWilliam D. Jones <thor0505@comcast.net>
Wed, 15 Aug 2018 21:16:07 +0000 (17:16 -0400)
committerWilliam D. Jones <thor0505@comcast.net>
Wed, 15 Aug 2018 21:18:19 +0000 (17:18 -0400)
passes/cmds/show.cc

index fa88cd66888ae70ec8f8ec87615ddd75569cb2bf..a48873244f63e6067ca87efde0b315b78c1104d9 100644 (file)
@@ -584,6 +584,7 @@ struct ShowPass : public Pass {
                log("\n");
                log("    -viewer <viewer>\n");
                log("        Run the specified command with the graphics file as parameter.\n");
+               log("        On Windows, this pauses yosys until the viewer exits.\n");
                log("\n");
                log("    -format <format>\n");
                log("        Generate a graphics file in the specified format. Use 'dot' to just\n");
@@ -645,7 +646,7 @@ struct ShowPass : public Pass {
                log("        do not add the module name as graph title to the dot file\n");
                log("\n");
                log("When no <format> is specified, 'dot' is used. When no <format> and <viewer> is\n");
-               log("specified, 'xdot' is used to display the schematic.\n");
+               log("specified, 'xdot' is used to display the schematic (POSIX systems only).\n");
                log("\n");
                log("The generated output files are '~/.yosys_show.dot' and '~/.yosys_show.<format>',\n");
                log("unless another prefix is specified using -prefix <prefix>.\n");