Update the datamodel class diagram, and use neato rather than dot, which gives

a much better result.

Signed-off-by: Ewan Mellor <ewan@xensource.com>

diff --git a/docs/Docs.mk b/docs/Docs.mk
index bc7c3befbd404f577c7eaef2f7ec0c93413d0efd..d6202139823e0dacb95ed35104bf713435733ac9 100644 (file)
--- a/docs/Docs.mk
+++ b/docs/Docs.mk
@@ -6,6 +6,7 @@ LATEX2HTML      := latex2html
 DOXYGEN                := doxygen
 POD2MAN                := pod2man
 DOT            := dot
+NEATO          := neato
 
 pkgdocdir      := /usr/share/doc/xen
 mandir         := /usr/share/man

diff --git a/docs/xen-api/Makefile b/docs/xen-api/Makefile
index dbc923137c6a3ab0fe095a418ea5f0a424dc0f61..dee807c65c02d1a464ba81578e04ffef7b94aa75 100644 (file)
--- a/docs/xen-api/Makefile
+++ b/docs/xen-api/Makefile
@@ -37,6 +37,9 @@ xenapi.dvi: $(TEX) $(EPS) $(EPSDOT)
 %.eps: %.dot
        $(DOT) -Tps $< >$@
 
+xenapi-datamodel-graph.eps: xenapi-datamodel-graph.dot
+       $(NEATO) -Goverlap=false -Tps $< >$@
+
 .PHONY: clean
 clean:
        rm -f *.pdf *.ps *.dvi *.aux *.log $(EPSDOT)

diff --git a/docs/xen-api/xenapi-datamodel-graph.dot b/docs/xen-api/xenapi-datamodel-graph.dot
index daeca1f6e5c7c955f71072ea1e8dd04e24234687..2a9f1071a9d7d700f46f14eee037bc90fde01f2c 100644 (file)
--- a/docs/xen-api/xenapi-datamodel-graph.dot
+++ b/docs/xen-api/xenapi-datamodel-graph.dot
@@ -1,18 +1,31 @@
-digraph g{
-node [ shape=box ]; session [ URL="session.html" ] task [ URL="task.html" ] VM [ URL="VM.html" ] host [ URL="host.html" ] host_cpu [ URL="host_cpu.html" ] network [ URL="network.html" ] VIF [ URL="VIF.html" ] PIF [ URL="PIF.html" ] SR [ URL="SR.html" ] VDI [ URL="VDI.html" ] VBD [ URL="VBD.html" ] VTPM [ URL="VTPM.html" ] console [ URL="console.html" ] user [ URL="user.html" ] debug [ URL="debug.html" ];
-session -> host [ label="this_host(1)" ]
-session -> user [ label="this_user(1)" ]
-host -> VM [ color="blue", arrowhead="crow", arrowtail="none" ]
-host -> host_cpu [ color="blue", arrowhead="crow", arrowtail="none" ]
-VIF -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
-VIF -> network [ color="blue", arrowhead="none", arrowtail="crow" ]
-PIF -> host [ color="blue", arrowhead="none", arrowtail="crow" ]
-PIF -> network [ color="blue", arrowhead="none", arrowtail="crow" ]
-SR -> VDI [ color="blue", arrowhead="crow", arrowtail="none" ]
-VDI -> VBD [ color="blue", arrowhead="crow", arrowtail="none" ]
-VDI -> VDI [ color="blue", arrowhead="none", arrowtail="crow" ]
-VBD -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
-VTPM -> VM [ label="backend(1)" ]
-VTPM -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
-console -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
+# Hand edited class diagram for the SDK -- HTML version
+# this one mentions all the classes so the imagemap works
+
+digraph "Xen-API Class Diagram" {
+fontname="Verdana";
+
+node [ shape=box ]; session VM host network VIF PIF SR VDI VBD PBD user;
+node [shape=ellipse]; PIF_metrics VIF_metrics VM_metrics VBD_metrics PBD_metrics VM_guest_metrics host_metrics;
+node [shape=box]; host_cpu console
+session -> host [ arrowhead="none" ]
+session -> user [ arrowhead="none" ]
+VM -> VM_metrics [ arrowhead="none" ]
+VM -> VM_guest_metrics [ arrowhead="none" ]
+VM -> console [ arrowhead="crow" ]
+host -> PBD [ arrowhead="crow", arrowtail="none" ]
+host -> host_metrics [ arrowhead="none" ]
+host -> host_cpu [ arrowhead="none" ]
+VIF -> VM [ arrowhead="none", arrowtail="crow" ]
+VIF -> network [ arrowhead="none", arrowtail="crow" ]
+VIF -> VIF_metrics [ arrowhead="none" ]
+PIF -> host [ arrowhead="none", arrowtail="crow" ]
+PIF -> network [ arrowhead="none", arrowtail="crow" ]
+PIF -> PIF_metrics [ arrowhead="none" ]
+SR -> PBD [ arrowhead="crow", arrowtail="none" ]
+PBD -> PBD_metrics [ arrowhead="none" ]
+SR -> VDI [ arrowhead="crow", arrowtail="none" ]
+VDI -> VBD [ arrowhead="crow", arrowtail="none" ]
+VBD -> VM [ arrowhead="none", arrowtail="crow" ]
+VTPM -> VM [ arrowhead="none", arrowtail="crow" ]
+VBD -> VBD_metrics [ arrowhead="none" ]
 }