summaryrefslogtreecommitdiff
path: root/kernel
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2013-02-28 13:59:49 +0100
committerClifford Wolf <clifford@clifford.at>2013-02-28 13:59:49 +0100
commitaf561800edc1d98c33fe057d5c02898460c9d6b9 (patch)
treebcfb0dce925ce7ab6b3c6dc6d0fe460431b47c77 /kernel
parent6ac41b2bb1d41328eb91c2622d8f70cb43a60f0f (diff)
Added online help for "show" and "hierarchy" commands
Diffstat (limited to 'kernel')
-rw-r--r--kernel/show.cc17
1 files changed, 16 insertions, 1 deletions
diff --git a/kernel/show.cc b/kernel/show.cc
index d7da62cd..eef4c44f 100644
--- a/kernel/show.cc
+++ b/kernel/show.cc
@@ -298,7 +298,22 @@ struct ShowWorker
};
struct ShowPass : public Pass {
- ShowPass() : Pass("show") { }
+ ShowPass() : Pass("show", "generate schematics using graphviz") { }
+ virtual void help()
+ {
+ // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
+ log("\n");
+ log(" show [-viewer <command>] [selection]\n");
+ log("\n");
+ log("Create a graphviz DOT file for the selected part of the design and compile it\n");
+ log("to a postscript file.\n");
+ log("\n");
+ log(" -viewer <command>\n");
+ log(" Also run the specified command with the postscript file as parameter.\n");
+ log("\n");
+ log("The generated output files are `yosys-show.dot' and `yosys-show.ps'.\n");
+ log("\n");
+ }
virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
{
log_header("Generating Graphviz representation of design.\n");