Commit Graph
237 Commits
Author SHA1 Message Date
sean@dague.net 829e31bad5 added block device content, including finding a few more bugs in xen 2005-11-18 12:58:16 +01:00
emellor@leeni.uk.xensource.com ed3752b5a0 Documentation: remove Twisted Matrix pre-req
Twisted Matrix is no longer necessary for Xen.  Removed from the
pre-requisites listed in the user documentation.

Signed-off-by: Andrew D. Ball <aball@us.ibm.com>
2005-11-17 12:10:08 +01:00
emellor@leeni.uk.xensource.com 8add0c9fed This patch explains network-* options in xm.1, including the bits that are
currently not really working.

Signed off by: Sean Dague <sean@dague.net>
2005-11-17 12:01:13 +01:00
emellor@leeni.uk.xensource.com cb248d6b16 The following patch removes every (hopefully) reference to network-limit.
Upon further investigation it sets Device parameters that don't exist any
longer, thus causing exceptions.  As it looks like this is completely
obsolete, and no one is actively working on it, we should just rip it out to
end the confusion.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-16 11:31:57 +01:00
emellor@leeni.uk.xensource.com 0e9ceb580a This patch is largely stylistic, and gets rid of StuddlyCaps formatting in
all the param variables, make consistant use of bold and italics in the the
man pages to make it easier to read, and adds a few minor content additions.
It makes actually reading the man page a lot easier.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:36:42 +01:00
emellor@leeni.uk.xensource.com 92c71aea0d This patch adds more content around the scheduler portions of the xm.1 man
page.  Most of this content came from the xensource wiki or the sedf doc in
the Xen tree.  It still needs more work, but it is a good first start.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:27:48 +01:00
emellor@leeni.uk.xensource.com c7509dd6cc This patch is another in the continued effort to flesh out the man pages, it
adds pretty reasonable text to most of the code xen domain and host commands
(device and scheduler will come in the future).

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:26:37 +01:00
emellor@leeni.uk.xensource.com aeedebd423 Further changes to xm.1 man page.
Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:52:16 +01:00
emellor@leeni.uk.xensource.com 23b53644ac The following patch is work in progress to add more meat to the xm.1 man
page.  Expect more content to trickle in over time.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:32:19 +01:00
Robb Romans c43564b41a Add "Securing Xen" adapted from Anthony Liguori's Wiki entry. 2005-11-10 11:43:24 -05:00
Robb Romans 35034c2a4b A few doc cleanups. Replace bitkeeper with mercurial. 2005-11-10 11:42:58 -05:00
emellor@leeni.uk.xensource.com 1455bb4870 Added description of the behaviour of rename-restart.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
2005-11-07 15:06:00 +01:00
kaf24@firebug.cl.cam.ac.uk d5dce3e452 The following patch adds a section for SHUTDOWN OPTIONS for the xmdomain.cfg
man page.  It documents the new set of options introduced over the last few
weeks.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-01 10:36:19 +01:00
kaf24@firebug.cl.cam.ac.uk e573e24eb8 Fix docs: xm set-mem => xm mem-set.
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2005-11-01 10:34:34 +01:00
kaf24@firebug.cl.cam.ac.uk 4d9db38409 Make check_pkgs work with the Bourne shell 2005-10-31 17:11:24 +01:00
emellor@leeni.uk.xensource.com 94608ed8f3 --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700
+++ xen-unstable.hg/docs/Makefile	2005-10-28 14:58:18.000000000 -0700
@@ -1,5 +1,6 @@
 #!/usr/bin/make -f

+VERSION		= xen-unstable
 INSTALL		= install
 INSTALL_DIR	= $(INSTALL) -d -m0755

@@ -9,9 +10,15 @@
 FIG2DEV		:= fig2dev
 LATEX2HTML	:= latex2html
 DOXYGEN		:= doxygen
+POD2MAN		:= pod2man

 pkgdocdir	:= /usr/share/doc/xen
+mandir		:= /usr/share/man

+DOC_MAN5SRC	:= $(wildcard man/*.pod.5)
+DOC_MAN1SRC	:= $(wildcard man/*.pod.1)
+DOC_MAN1	:= $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
+DOC_MAN5	:= $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
 DOC_TEX		:= src/user.tex src/interface.tex
 DOC_PS		:= $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
 DOC_PDF		:= $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
@@ -22,7 +29,7 @@
 .PHONY:	all build dev-docs python-dev-docs ps pdf html clean install

 all: build
-build: ps pdf html
+build: ps pdf html man-pages
 	rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc

 dev-docs: python-dev-docs
@@ -43,17 +50,36 @@
 	$(MAKE) -C api/tools/python/latex ; else                   \
         echo "Doxygen not installed; skipping python-dev-docs."; fi

+man-pages:
+	@if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \
+	$(MAKE) $(DOC_MAN1) $(DOC_MAN5); fi
+
+man1/%.1: man/%.pod.1 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man1.//'| \
+		sed 's/.1//'` -s 1 -c "Xen" $< $@
+
+man5/%.5: man/%.pod.5 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man5.//'| \
+		sed 's/.5//'` -s 5 -c "Xen" $< $@
+
 clean:
 	rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
 	rm -rf *.ilg *.log *.ind *.toc *.bak core
 	rm -rf $(GFX) ps pdf html
 	rm -rf api
+	rm -rf man5
+	rm -rf man1

 install: all
 	rm -rf $(DESTDIR)$(pkgdocdir)
 	$(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)
 	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)

 pdf/%.pdf: ps/%.ps
2005-10-30 17:20:09 +01:00
kaf24@firebug.cl.cam.ac.uk 1660169e32 Remove linux-2.4 sparse tree.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-10-07 23:36:26 +01:00
kaf24@firebug.cl.cam.ac.uk ccaff07480 Update User's Guide installation section to mention hotplug.
Now that hotplug seems to be necessary to boot new domains (at least, to
get disk access in those domains), add a note to the installation guide
mentioning this dependency.

Signed-off-by: Michael Vrable <mvrable@cs.ucsd.edu>
2005-09-23 20:10:32 +01:00
kaf24@firebug.cl.cam.ac.uk 3466017825 Split up docs. Signed-off-by: Robb Romans <3r@us.ibm.com> 2005-09-20 09:17:33 +00:00
emellor@ewan 3f5123b9de Issue warning if doxygen is not installed.
Signed-off-by: Ewan Mellor<ewan@xensource.com>
2005-09-17 13:59:35 +01:00
cl349@firebug.cl.cam.ac.uk ca899c5e1e Rename xm commands and cleanup of the "bogus" argument code.
For the "bogus" argument code, avoid changing the argument list so
that errors can be reported consistently.
Signed-off-by: Dan Smith <danms@us.ibm.com>
Signed-off-by: Christian Limpach <Christian.Limpach@cl.cam.ac.uk>
2005-09-14 17:06:25 +00:00
ewan@linford.intra f909827ad1 Pass the root directory to Doxyfilter and thence pythfilter.py so that the latter can get the namespace/packages correct. 2005-09-13 14:42:21 +01:00
ewan@linford.intra 7073778b38 Pass the root directory to Doxyfilter and thence pythfilter.py so that the latter can get the namespace/packages correct. 2005-09-13 14:41:05 +01:00
ewan@linford.intra b7d4a69f0c "Added." 2005-09-11 21:40:15 +01:00
ewan@linford.intra 700f66a7ed Added dev-docs target to build the Python Tools' API documentation. 2005-09-11 21:12:40 +01:00
shand@ubuntu.eng.hq.xensource.com 142a767280 Documentation about how to use the virtual TPM implementation.
Signed-off-by: Steven Hand <steven@xensource.com> 
Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2005-08-30 11:19:52 -08:00
kaf24@firebug.cl.cam.ac.uk 7184ccd780 Default unit for all Xen memory parameters is kilobytes.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-08-19 09:16:56 +00:00
kaf24@firebug.cl.cam.ac.uk 39ec3e6c6a This patch:
* adds a C-based security policy translation tool to Xen (secpol_xml2bin) 
and removes the current Java 
security policy translator (Java dependencies).  The C-based tool 
integrates into the Xen source tree build 
and install (using gnome libxml2 for XML parsing). See install.txt.

* introduces security labels and related tools. Users can now use 
semantic-rich label names to put security-tags 
on domains. See example.txt, policy.txt.

* moves the security configuration (currently ACM_USE_SECURITY_POLICY) 
from xen/Rules.mk 
into a separate top-level Security.mk file  (it is needed by the 
tools/security and xen/acm).

Both xen/acm and tools/security are built during the Xen build process 
only if ACM_USE_SECURITY_POLICY 
is not ACM_NULL_POLICY (which is the default setting).

Signed-off-by Reiner Sailer <sailer@us.ibm.com>
Signed-off by Stefan Berger <stefanb@us.ibm.com>
Signed-off by Ray Valdez <rvaldez@us.ibm.com>
2005-08-19 09:03:17 +00:00
kaf24@firebug.cl.cam.ac.uk 98506e40b1 On x86, Xen does not claim any serial port unless the user
explicitly specifies a 'com1=' or 'com2=' configuration
string. This prevents users from being surprised when Xen
stops domain0 from accessing serial port registers.

On ia64 we still allow serial ports to get automatically
configured and locked down even if no 'com1' is specified
on the command line. This maintains the default preferred
by the IA64 developers.

Also, the method for specifying 'use existing baud rate'
has changed. Instead of specifying com1=0, you must now
specify e.g., com1=auto

Signed-off-by: Keir Fraser <keir@xensource.com>
2005-08-03 14:44:19 +00:00
kaf24@firebug.cl.cam.ac.uk ecfbf99a10 This patch renames balloon command to "set-mem", so instead of "xm
balloon", we will use "xm set-mem" (as suggested by TODO list)

Signed-off-by: Nguyen Anh Quynh <aquynh@gmail.com>
2005-07-29 10:37:30 +00:00
kaf24@firebug.cl.cam.ac.uk e39ba51523 - allows to optionally boot the system with a policy already being
active at startup; this works by adding a module line into the grub
  configuration file and placing the binary policy generated by the
  policy tool into the boot directory; This assumes that a maximum of
  one module line is used for the initrd in the grub configuration
  file - Question: do users pass more than one module to the kernel?
- enables the policy hypervisor call on x86/64
- some function prototypes moved to include files
- moves the version number in the java tool up to the current
  version (a better way of doing this will be submitted soon)

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
Signed-off-by: Reiner Sailer <sailer@us.ibm.com>
2005-07-25 21:19:14 +00:00
kaf24@firebug.cl.cam.ac.uk 08daf6e614 Allow IRQ balancing to be disabled with 'noirqbalance'
boot parameter.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-07-14 10:37:49 +00:00
ach61@arcadians.cl.cam.ac.uk b9527ee31a update hg cheatsheet 2005-07-06 18:27:32 +00:00
gmilos@localhost.localdomain 905bd75893 Example of assymetric pull/push paths. 2005-07-04 15:01:22 +00:00
gmilos@localhost.localdomain b9db0e99ab Extended explanation of 'hg diff'. 2005-07-04 14:47:28 +00:00
kaf24@firebug.cl.cam.ac.uk 580220fea2 This patch fixes few typos in hg-cheatsheet.txt
Signed-off-by: Nguyen Anh Quynh <aquynh@gmail.com>
2005-07-01 15:43:44 +00:00
iap10@freefall.cl.cam.ac.uk dbf7e82d46 Add the Mercurial for Xen cheatsheet into the repo.
Signed-off-by: ian@xensource.com
2005-07-01 10:21:30 +00:00
smh22@firebug.cl.cam.ac.uk 26922e5f08 bitkeeper revision 1.1723 (42b7c4f7lKvZiHctN9YxRzuWreG0iQ)
quiet xm ssid-ref output for now - use policy tool or -l for details
2005-06-21 07:42:47 +00:00
smh22@firebug.cl.cam.ac.uk 198553df06 bitkeeper revision 1.1718.1.8 (42b7436bQ2MohyJ9wW6onfFsyW6VGg)
shype4xen_readme.txt:
  new file
2005-06-20 22:30:03 +00:00
ach61@arcadians.cl.cam.ac.uk c39f4a5931 bitkeeper revision 1.1713.1.11 (42b03e2dFl47vRNjIHPpu-GWrag_zA)
remove obsolete debugger documentation
2005-06-15 14:41:49 +00:00
kaf24@firebug.cl.cam.ac.uk 910bf81124 bitkeeper revision 1.1691.1.16 (42a7f3f3e6lVJ85_T1bXVdbucWiu9g)
This patch removes -noht option (both code and doc).
Signed-off-by: Nguyen Anh Quynh <aquynh@gmail.com>
2005-06-09 07:46:59 +00:00
kaf24@firebug.cl.cam.ac.uk 4b6d488ea0 bitkeeper revision 1.1671 (42a1e8cdI_f9OiPqscVnjrOWWEVTmw)
Add a manual 'sync_console' boot parameter that forces synchronous
console output. May be useful for systems that crash unexpectedly
and lose the last chunk of console output.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-06-04 17:45:49 +00:00
cl349@firebug.cl.cam.ac.uk f5e464d82a bitkeeper revision 1.1608 (429c646erSBefwnCqVeHKzsRTMIwjA)
Merge.
2005-05-31 13:19:42 +00:00
cl349@firebug.cl.cam.ac.uk acbaea9bb9 bitkeeper revision 1.1159.258.159 (429c6342A2HJ4wUj0nM5MNauX7azZQ)
vnet-xend.txt, user.tex, README:
  Update the Linux kernel version number from 2.6.9 to 2.6 or 2.6.11
  in several places in documentation.
Original patch provided by Andrew Thompson <andrewkt@aktzero.com>
Signed-off-by: Christian Limpach <Christian.Limpach@cl.cam.ac.uk>
2005-05-31 13:14:42 +00:00
kaf24@firebug.cl.cam.ac.uk 10b7bf98cb bitkeeper revision 1.1599 (429b828aL4XKwdaPjLGObI37F4hwiw)
By default do not enable local APIC if disabled by the BIOS. This
matches Linux behaviour and ought to improve stability on buggy
hardware/firmware (laptops in particular). As in Linux, you can
forcibly enable the APIC with 'lapic' command-line option, or
forcibly ignore it with 'nolapic'.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-05-30 21:15:54 +00:00
smh22@firebug.cl.cam.ac.uk 88de3d14a6 bitkeeper revision 1.1425 (4289b159Cmh6NHAqKpwaWnNgVs6sWA)
user.tex:
  note differences between 2.x and 3.x
2005-05-17 08:54:49 +00:00
kaf24@firebug.cl.cam.ac.uk bfad555857 bitkeeper revision 1.1415 (42887ada_Jmkta2rYHnpJBE2EVpy4w)
Remove generic 'fast trap' from the Xen public interfaces. Internally
within Xen, we automatically set up direct trap for int 0x80, which is
the only 'fast trap' vector that we ever supported anyway.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-05-16 10:50:02 +00:00
kaf24@firebug.cl.cam.ac.uk 739050b063 bitkeeper revision 1.1389.1.52 (42839937dfdfndUpTNENRU4pLS6XDw)
Add 'apic={verbose,debug}' option to Xen. Same meaning as on Linux
command line, and automatically propagated to domain0 command line.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-05-12 17:58:15 +00:00
kaf24@firebug.cl.cam.ac.uk 841992ba6c bitkeeper revision 1.1389.17.2 (42823d03EYcqclnB3eLTbH6vjWBSEA)
Fix docs.
Signed-off-by: Keir Fraser <keir@xensource.com>
2005-05-11 17:12:35 +00:00
kaf24@firebug.cl.cam.ac.uk bfe89d9ca0 bitkeeper revision 1.1389.17.1 (42823056RNtq4AlseRHL98DJV2uJgA)
Change the Xen command-line parameter syntax. 'noacpi' and 
'ignorebiostables' are gone. 'dom0_mem' can optionally take a k/m/g
suffix to specify units (default units are still kilobytes).

Also added:
 1. 'mem=xxx' to specify maximum physical RAM address (supports
     k/m/g suffix)
 2. acpi=xxx/acpi_skip_timer_override/noapic: These all have same
    semantics as in Linux. They are *automatically* propagated to
    the domain0 command line, as dom0 shares resposibility for
    platform initialisation.

Signed-off-by: Keir Fraser <keir@xensource.com>
2005-05-11 16:18:30 +00:00