From af561800edc1d98c33fe057d5c02898460c9d6b9 Mon Sep 17 00:00:00 2001
From: Clifford Wolf <clifford@clifford.at>
Date: Thu, 28 Feb 2013 13:59:49 +0100
Subject: Added online help for "show" and "hierarchy" commands

---
 kernel/show.cc | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'kernel')

diff --git a/kernel/show.cc b/kernel/show.cc
index d7da62cd2..eef4c44f8 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");
-- 
cgit v1.2.3