Removed references to yosys-svgviewer from docs
authorClifford Wolf <clifford@clifford.at>
Tue, 2 Sep 2014 02:03:06 +0000 (04:03 +0200)
committerClifford Wolf <clifford@clifford.at>
Tue, 2 Sep 2014 02:03:06 +0000 (04:03 +0200)
.gitignore
manual/APPNOTE_011_Design_Investigation.tex
manual/CHAPTER_Auxprogs.tex
passes/cmds/show.cc

index bb50d357bf50b993c63f9fc8a09cc9a396a5b414..803e130263ed0311993484c06f1ad341a41860ea 100644 (file)
@@ -15,6 +15,5 @@
 /yosys-abc
 /yosys-config
 /yosys-filterlib
-/yosys-svgviewer
 /kernel/version_*.cc
 /share
index c04811864385b6e93811658763e8c7946f22b8f2..504ab7ec6d98b43a81249ac31254585feb89327b 100644 (file)
@@ -54,7 +54,7 @@
 \begin{document}
 
 \title{Yosys Application Note 011: \\ Interactive Design Investigation}
-\author{Clifford Wolf \\ December 2013}
+\author{Clifford Wolf \\ Original Verision December 2013}
 \maketitle
 
 \begin{abstract}
@@ -74,9 +74,7 @@ commands for evaluating circuits and solving SAT problems.
 This Application Note is based on the Yosys \cite{yosys} GIT Rev. {\tt 2b90ba1} from
 2013-12-08. The {\tt README} file covers how to install Yosys. The
 {\tt show} command requires a working installation of GraphViz \cite{graphviz}
-for generating the actual circuit diagrams. Yosys must be build with Qt
-support for the built-in SVG viewer. Alternatively an external viewer can be
-used, if Qt is not available.
+and \cite{xdot} for generating the actual circuit diagrams.
 
 \section{Overview}
 
@@ -131,8 +129,8 @@ The {\tt show} command generates a circuit diagram for the design in its
 current state. Various options can be used to change the appearance of the
 circuit diagram, set the name and format for the output file, and so forth.
 When called without any special options, it saves the circuit diagram in
-a temporary file and launches {\tt yosys-svgviewer} to display the diagram.
-Subsequent calls to {\tt show} re-use the {\tt yosys-svgviewer} instance
+a temporary file and launches {\tt xdot} to display the diagram.
+Subsequent calls to {\tt show} re-use the {\tt xdot} instance
 (if still running).
 
 \subsection{A simple circuit}
@@ -270,18 +268,12 @@ command only operates on interior signals.
 
 \subsection{Miscellaneous notes}
 
-Per default the {\tt show} command outputs a temporary SVG file and launches
-{\tt yosys-svgviewer} to display it. The options {\tt -format}, {\tt -viewer}
+Per default the {\tt show} command outputs a temporary {\tt dot} file and launches
+{\tt xdot} to display it. The options {\tt -format}, {\tt -viewer}
 and {\tt -prefix} can be used to change format, viewer and filename prefix.
 Note that the {\tt pdf} and {\tt ps} format are the only formats that support
 plotting multiple modules in one run.
 
-In {\tt yosys-svgviewer} the left mouse button is per default bound to move the
-diagram (and the mouse wheel can be used for zooming in and out). However, in
-some cases one wants to copy text from the diagram. In this cases the
-View->Interactive checkbox must be activated. This switches the rendering back-end
-in a mode that supports interaction with the SVG file, such as selecting text.
-
 In densely connected circuits it is sometimes hard to keep track of the
 individual signal wires. For this cases it can be useful to call {\tt show}
 with the {\tt -colors <integer>} argument, which randomly assigns colors to the
@@ -1056,6 +1048,10 @@ Clifford Wolf. The Yosys Open SYnthesis Suite.
 Graphviz - Graph Visualization Software.
 \url{http://www.graphviz.org/}
 
+\bibitem{xdot}
+xdot.py - an interactive viewer for graphs written in Graphviz's dot language.
+\url{https://github.com/jrfonseca/xdot.py}
+
 \bibitem{CircuitSAT}
 {\it Circuit satisfiability problem} on Wikipedia
 \url{http://en.wikipedia.org/wiki/Circuit_satisfiability}
index eefd369704093d6e1934493f0dd786ce22be07a4..cce3741c2326ab962418a5bced67b25c19619f97 100644 (file)
@@ -17,10 +17,3 @@ The {\tt yosys-filterlib} tool is a small utility that can be used to strip
 or extract information from a Liberty file. See Sec.~\ref{sec:techmap_extern}
 for details.
 
-\section{yosys-svgviewer}
-
-The {\tt yosys-svgviewer} tool is a small Qt program that can be used to view
-SVG files. This tool is automatically launched by the {\tt show} command when
-no {\tt -format} and no {\tt -viewer} option is passed to the command. See
-{\tt help show} or Sec.~\ref{cmd:show} for details.
-
index 6ab0e1ba1a5a25a752312fc83cef103522999498..0451ebc2992ff14717d46c780592d4ad7ff03bfa 100644 (file)
@@ -598,8 +598,8 @@ struct ShowPass : public Pass {
                log("    -notitle\n");
                log("        do not add the module name as graph title to the dot file\n");
                log("\n");
-               log("When no <format> is specified, SVG is used. When no <format> and <viewer> is\n");
-               log("specified, 'yosys-svgviewer' is used to display the schematic.\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("\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");