ia64/xen-unstable

changeset 14754:7cce8838abe0

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>
author Ewan Mellor <ewan@xensource.com>
date Thu Apr 05 17:22:22 2007 +0100 (2007-04-05)
parents 83ce6f4da212
children 69ab63bee57c
files docs/Docs.mk docs/xen-api/Makefile docs/xen-api/xenapi-datamodel-graph.dot
line diff
     1.1 --- a/docs/Docs.mk	Thu Apr 05 15:47:03 2007 +0100
     1.2 +++ b/docs/Docs.mk	Thu Apr 05 17:22:22 2007 +0100
     1.3 @@ -6,6 +6,7 @@ LATEX2HTML	:= latex2html
     1.4  DOXYGEN		:= doxygen
     1.5  POD2MAN		:= pod2man
     1.6  DOT		:= dot
     1.7 +NEATO		:= neato
     1.8  
     1.9  pkgdocdir	:= /usr/share/doc/xen
    1.10  mandir		:= /usr/share/man
     2.1 --- a/docs/xen-api/Makefile	Thu Apr 05 15:47:03 2007 +0100
     2.2 +++ b/docs/xen-api/Makefile	Thu Apr 05 17:22:22 2007 +0100
     2.3 @@ -37,6 +37,9 @@ xenapi.dvi: $(TEX) $(EPS) $(EPSDOT)
     2.4  %.eps: %.dot
     2.5  	$(DOT) -Tps $< >$@
     2.6  
     2.7 +xenapi-datamodel-graph.eps: xenapi-datamodel-graph.dot
     2.8 +	$(NEATO) -Goverlap=false -Tps $< >$@
     2.9 +
    2.10  .PHONY: clean
    2.11  clean:
    2.12  	rm -f *.pdf *.ps *.dvi *.aux *.log $(EPSDOT)
     3.1 --- a/docs/xen-api/xenapi-datamodel-graph.dot	Thu Apr 05 15:47:03 2007 +0100
     3.2 +++ b/docs/xen-api/xenapi-datamodel-graph.dot	Thu Apr 05 17:22:22 2007 +0100
     3.3 @@ -1,18 +1,31 @@
     3.4 -digraph g{
     3.5 -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" ];
     3.6 -session -> host [ label="this_host(1)" ]
     3.7 -session -> user [ label="this_user(1)" ]
     3.8 -host -> VM [ color="blue", arrowhead="crow", arrowtail="none" ]
     3.9 -host -> host_cpu [ color="blue", arrowhead="crow", arrowtail="none" ]
    3.10 -VIF -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.11 -VIF -> network [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.12 -PIF -> host [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.13 -PIF -> network [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.14 -SR -> VDI [ color="blue", arrowhead="crow", arrowtail="none" ]
    3.15 -VDI -> VBD [ color="blue", arrowhead="crow", arrowtail="none" ]
    3.16 -VDI -> VDI [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.17 -VBD -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.18 -VTPM -> VM [ label="backend(1)" ]
    3.19 -VTPM -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.20 -console -> VM [ color="blue", arrowhead="none", arrowtail="crow" ]
    3.21 +# Hand edited class diagram for the SDK -- HTML version
    3.22 +# this one mentions all the classes so the imagemap works
    3.23 +
    3.24 +digraph "Xen-API Class Diagram" {
    3.25 +fontname="Verdana";
    3.26 +
    3.27 +node [ shape=box ]; session VM host network VIF PIF SR VDI VBD PBD user;
    3.28 +node [shape=ellipse]; PIF_metrics VIF_metrics VM_metrics VBD_metrics PBD_metrics VM_guest_metrics host_metrics;
    3.29 +node [shape=box]; host_cpu console
    3.30 +session -> host [ arrowhead="none" ]
    3.31 +session -> user [ arrowhead="none" ]
    3.32 +VM -> VM_metrics [ arrowhead="none" ]
    3.33 +VM -> VM_guest_metrics [ arrowhead="none" ]
    3.34 +VM -> console [ arrowhead="crow" ]
    3.35 +host -> PBD [ arrowhead="crow", arrowtail="none" ]
    3.36 +host -> host_metrics [ arrowhead="none" ]
    3.37 +host -> host_cpu [ arrowhead="none" ]
    3.38 +VIF -> VM [ arrowhead="none", arrowtail="crow" ]
    3.39 +VIF -> network [ arrowhead="none", arrowtail="crow" ]
    3.40 +VIF -> VIF_metrics [ arrowhead="none" ]
    3.41 +PIF -> host [ arrowhead="none", arrowtail="crow" ]
    3.42 +PIF -> network [ arrowhead="none", arrowtail="crow" ]
    3.43 +PIF -> PIF_metrics [ arrowhead="none" ]
    3.44 +SR -> PBD [ arrowhead="crow", arrowtail="none" ]
    3.45 +PBD -> PBD_metrics [ arrowhead="none" ]
    3.46 +SR -> VDI [ arrowhead="crow", arrowtail="none" ]
    3.47 +VDI -> VBD [ arrowhead="crow", arrowtail="none" ]
    3.48 +VBD -> VM [ arrowhead="none", arrowtail="crow" ]
    3.49 +VTPM -> VM [ arrowhead="none", arrowtail="crow" ]
    3.50 +VBD -> VBD_metrics [ arrowhead="none" ]
    3.51  }