install more documentation to /usr/share/doc/xen and /etc/xen
authorKeir Fraser <keir.fraser@citrix.com>
Wed, 6 Aug 2008 08:34:55 +0000 (09:34 +0100)
committerKeir Fraser <keir.fraser@citrix.com>
Wed, 6 Aug 2008 08:34:55 +0000 (09:34 +0100)
Also resync xmexample3 with xmexample1 and 2.

Signed-off-by: Samuel Thibault <samuel.thibault@eu.citrix.com>
Config.mk
docs/Docs.mk
docs/Makefile
docs/xen-api/Makefile
stubdom/Makefile
tools/blktap/Makefile
tools/examples/Makefile
tools/examples/README
tools/examples/xmexample3
tools/xenmon/Makefile

index 2cb15d4be013244ad17a11d7f8c82e8812b55d3d..65f2de88ec5f936dda220f3e0461b54ff813b875 100644 (file)
--- a/Config.mk
+++ b/Config.mk
@@ -19,6 +19,8 @@ HOSTCFLAGS += -fno-strict-aliasing
 
 DISTDIR     ?= $(XEN_ROOT)/dist
 DESTDIR     ?= /
+DOCDIR      ?= /usr/share/doc/xen
+MANDIR      ?= /usr/share/man
 
 # Allow phony attribute to be listed as dependency rather than fake target
 .PHONY: .phony
index d6202139823e0dacb95ed35104bf713435733ac9..3c95cfca454e2240646b42e249525339498a3d37 100644 (file)
@@ -7,7 +7,3 @@ DOXYGEN         := doxygen
 POD2MAN                := pod2man
 DOT            := dot
 NEATO          := neato
-
-pkgdocdir      := /usr/share/doc/xen
-mandir         := /usr/share/man
-
index b4120081258520a5112ec807f9aca5d766fa0aee..dce7cd9d3174f8b159e807ae03b443445f0b771a 100644 (file)
@@ -80,17 +80,17 @@ distclean: clean
 
 .PHONY: install
 install: all
-       rm -rf $(DESTDIR)$(pkgdocdir)
-       $(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)
+       rm -rf $(DESTDIR)$(DOCDIR)
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
 
        $(MAKE) -C xen-api install
 
-       cp -dR ps $(DESTDIR)$(pkgdocdir)
-       cp -dR pdf $(DESTDIR)$(pkgdocdir)
-       $(INSTALL_DIR) $(DESTDIR)$(mandir)
-       cp -dR man1 $(DESTDIR)$(mandir)
-       cp -dR man5 $(DESTDIR)$(mandir)
-       [ ! -d html ] || cp -dR html $(DESTDIR)$(pkgdocdir)
+       cp -dR ps $(DESTDIR)$(DOCDIR)
+       cp -dR pdf $(DESTDIR)$(DOCDIR)
+       $(INSTALL_DIR) $(DESTDIR)$(MANDIR)
+       cp -dR man1 $(DESTDIR)$(MANDIR)
+       cp -dR man5 $(DESTDIR)$(MANDIR)
+       [ ! -d html ] || cp -dR html $(DESTDIR)$(DOCDIR)
 
 pdf/%.pdf: ps/%.ps
        $(INSTALL_DIR) $(@D)
index 214f94325a177923a4498cc239069d73609fbecf..a25286a30a85a838bcbfdebbf26c75f407a7f37a 100644 (file)
@@ -16,11 +16,11 @@ all: build
 build: xenapi.pdf xenapi.ps
 
 install:
-       $(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)/ps
-       $(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)/pdf
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)/ps
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)/pdf
 
-       [ -e xenapi.ps ] && cp xenapi.ps $(DESTDIR)$(pkgdocdir)/ps || true
-       [ -e xenapi.pdf ] && cp xenapi.pdf $(DESTDIR)$(pkgdocdir)/pdf || true
+       [ -e xenapi.ps ] && cp xenapi.ps $(DESTDIR)$(DOCDIR)/ps || true
+       [ -e xenapi.pdf ] && cp xenapi.pdf $(DESTDIR)$(DOCDIR)/pdf || true
 
 xenapi.dvi: $(TEX) $(EPS) $(EPSDOT)
        $(LATEX) xenapi.tex
index 753aabd0bf5d3acbf9fdd8c027f9f42de2cd5dce..6a39c39e7d016044f18b52d99cfecf3673247ba4 100644 (file)
@@ -296,11 +296,15 @@ pv-grub: mini-os-grub libxc grub
 #########
 
 ifeq ($(STUBDOM_SUPPORTED),1)
-install: install-ioemu install-grub
+install: install-readme install-ioemu install-grub
 else
 install:
 endif
 
+install-readme:
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
+       $(INSTALL_DATA) README $(DESTDIR)$(DOCDIR)/README.stubdom
+
 install-ioemu: ioemu-stubdom
        $(INSTALL_DIR) "$(DESTDIR)/usr/lib/xen/bin"
        $(INSTALL_PROG) stubdom-dm "$(DESTDIR)/usr/lib/xen/bin"
index 871e2c4b60841189d5702ec50a5851e4b87c595c..21c9556f60698119a45dd2998489e77b9b94947f 100644 (file)
@@ -8,3 +8,6 @@ SUBDIRS-y += drivers
 .PHONY: all clean install
 all clean install: %: subdirs-%
 
+install:
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
+       $(INSTALL_DATA) README $(DESTDIR)$(DOCDIR)/README.blktap
index 8f967084a55555698527297403e51cc983857dcc..39310394f5600c6d0cf2a6edfc6d6d603107b56b 100644 (file)
@@ -8,11 +8,18 @@ XENDOMAINS_SYSCONFIG = init.d/sysconfig.xendomains
 
 # Xen configuration dir and configs to go there.
 XEN_CONFIG_DIR = /etc/xen
+XEN_READMES = README
+XEN_READMES += README.incompatibilities
 XEN_CONFIGS = xend-config.sxp
 XEN_CONFIGS += xm-config.xml
 XEN_CONFIGS += xmexample1 
 XEN_CONFIGS += xmexample2
+XEN_CONFIGS += xmexample3
 XEN_CONFIGS += xmexample.hvm
+XEN_CONFIGS += xmexample.hvm-stubdom
+XEN_CONFIGS += xmexample.hvm-dm
+XEN_CONFIGS += xmexample.pv-grub
+XEN_CONFIGS += xmexample.nbd
 XEN_CONFIGS += xmexample.vti
 XEN_CONFIGS += xend-pci-quirks.sxp
 XEN_CONFIGS += xend-pci-permissive.sxp
@@ -59,7 +66,16 @@ all:
 build:
 
 .PHONY: install
-install: all install-initd install-configs install-scripts $(HOTPLUGS)
+install: all install-readmes install-initd install-configs install-scripts $(HOTPLUGS)
+
+.PHONY: install-readmes
+install-readmes:
+       [ -d $(DESTDIR)$(XEN_CONFIG_DIR) ] || \
+               $(INSTALL_DIR) $(DESTDIR)$(XEN_CONFIG_DIR)
+       set -e; for i in $(XEN_READMES); \
+           do [ -e $(DESTDIR)$(XEN_CONFIG_DIR)/$$i ] || \
+           $(INSTALL_DATA) $$i $(DESTDIR)$(XEN_CONFIG_DIR); \
+       done
 
 .PHONY: install-initd
 install-initd:
index 00ef8dc3522a9aefcc9430e1c68f976ae1959816..e2e8f434df8297774eb7e6bd53b85872a395ee1a 100644 (file)
@@ -44,4 +44,8 @@ xmexample3          - an advanced configuration script for 'xm create'
 xmexample.nbd       - configuration script that uses NBD filesystems
 xmexample.hvm       - a configuration script for creating a hvm domain with
                       'xm create'
+xmexample.hvm-stubdom - a configuration script for creating a hvm domain with
+                        'xm create' that utilizes a stubdomain for device model
+xmexample.pv-grub   - a configuration script for creating a domain with 'xm create'
+                      which boots PV-GRUB.
 xmexample.vti       - a configuration script for creating a domain on vti
index 8610fcc483d3b2080671834f8f0bf5b4a31b7400..99281904fd0ab8a15bbd51e1e401d4bf43b306c1 100644 (file)
@@ -207,4 +207,26 @@ extra = "4 VMID=%d" % vmid
 #on_reboot   = 'restart'
 #on_crash    = 'restart'
 
+#-----------------------------------------------------------------------------
+#   Configure PVSCSI devices:
+#
+#vscsi=[ 'PDEV, VDEV' ]
+#
+#   PDEV   gives physical SCSI device to be attached to specified guest
+#          domain by one of the following identifier format.
+#          - XX:XX:XX:XX (4-tuples with decimal notation which shows
+#                          "host:channel:target:lun")
+#          - /dev/sdxx or sdx
+#          - /dev/stxx or stx
+#          - /dev/sgxx or sgx
+#          - result of 'scsi_id -gu -s'.
+#            ex. # scsi_id -gu -s /block/sdb
+#                  36000b5d0006a0000006a0257004c0000
+#
+#   VDEV   gives virtual SCSI device by 4-tuples (XX:XX:XX:XX) as 
+#          which the specified guest domain recognize.
+#
+
+#vscsi = [ '/dev/sdx, 0:0:0:0' ]
+
 #============================================================================
index 1a53d65d22f30b343f17d7cbc621a2ea1bb1544e..0b35f451d0f834ebdeab1127e18295fbe1d6dae2 100644 (file)
@@ -33,6 +33,8 @@ install: build
        $(INSTALL_PROG) xenbaked $(DESTDIR)$(SBINDIR)/xenbaked
        $(INSTALL_PROG) xentrace_setmask  $(DESTDIR)$(SBINDIR)/xentrace_setmask
        $(INSTALL_PROG) xenmon.py  $(DESTDIR)$(SBINDIR)/xenmon.py
+       $(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
+       $(INSTALL_DATA) README $(DESTDIR)$(DOCDIR)/README.xenmon
 
 .PHONY: clean
 clean: