ia64/xen-unstable

changeset 1973:e8d6db73f188

bitkeeper revision 1.1108.33.4 (41081a99OANenGnR3ffwrKZGn0vPPQ)

Smaller manual tweaks.
author mwilli2@equilibrium.research.intel-research.net
date Wed Jul 28 21:28:57 2004 +0000 (2004-07-28)
parents e295e6b0e112
children 0475742a106f
files docs/user.tex
line diff
     1.1 --- a/docs/user.tex	Wed Jul 28 21:16:40 2004 +0000
     1.2 +++ b/docs/user.tex	Wed Jul 28 21:28:57 2004 +0000
     1.3 @@ -85,15 +85,15 @@ progress:
     1.4  \item Windows XP
     1.5  \end{itemize}
     1.6  
     1.7 -Right now, Linux 2.4 and 2.6 are available for on Xen 2.0 (the
     1.8 -modifications to Linux are distributed with Xen).  The NetBSD port
     1.9 -will be updated to run on Xen 2.0, hopefully in time for the Xen 2.0
    1.10 -release.  Even running multiple copies of the same OS can be very
    1.11 -useful, as it provides a means of containing faults to one OS image,
    1.12 -and also for providing performance isolation between the various OS,
    1.13 -enabling you to either restrict, or reserve resources for, particular
    1.14 -VM instances.  It is intended that Xen support be integrated into the
    1.15 -official releases of Linux 2.6, NetBSD 2.0, FreeBSD and Dragonfly.
    1.16 +Right now, Linux 2.4 and 2.6 are available for on Xen 2.0.  NetBSD
    1.17 +port will be updated to run on Xen 2.0, hopefully in time for the Xen
    1.18 +2.0 release.  It is intended that Xen support be integrated into the
    1.19 +official releases of Linux 2.6, NetBSD 2.0, FreeBSD and Dragonfly BSD.
    1.20 +
    1.21 +Even running multiple copies of Linux can be very useful, providing a
    1.22 +means of containing faults to one OS image, providing performance
    1.23 +isolation between the various OS instances and trying out multiple
    1.24 +distros.
    1.25  
    1.26  The Windows XP port is only available to those who have signed the
    1.27  Microsoft Academic Source License.
    1.28 @@ -164,8 +164,8 @@ ported to others. In fact, it would have
    1.29  Xen for pretty much any other architecture as x86 is particularly
    1.30  tricky to handle. A good description of Xen's design, implementation
    1.31  and performance is contained in the October 2003 SOSP paper, available
    1.32 -at:
    1.33 -{\tt http://www.cl.cam.ac.uk/netos/papers/2003-xensosp.pdf}
    1.34 +at:\\
    1.35 +{\tt http://www.cl.cam.ac.uk/netos/papers/2003-xensosp.pdf}\\
    1.36  Work to port Xen to x86\_64 and IA64 is currently underway.
    1.37  
    1.38  Xen is targetted at server-class machines, and the current list of
    1.39 @@ -179,7 +179,7 @@ Xen requires a ``P6'' or newer processor
    1.40  Pentium II, Pentium III, Pentium IV, Xeon, AMD Athlon, AMD Duron).
    1.41  Multiprocessor machines are supported, and we also have basic support
    1.42  for HyperThreading (SMT), although this remains a topic for ongoing
    1.43 -research. We're also working on an x86_64 port (though Xen should
    1.44 +research. We're also working on an x86\_64 port (though Xen should
    1.45  already run on these systems just fine in 32-bit mode).
    1.46  
    1.47  Xen can currently use up to 4GB of memory.  It is possible for x86
    1.48 @@ -220,7 +220,7 @@ Cambridge, and HP Labs, who are now work
    1.49  also in receipt of support from Microsoft Research Cambridge to port
    1.50  Windows XP to run on Xen.
    1.51  
    1.52 -Xen was first described in the 2003 paper at SOSP
    1.53 +Xen was first described in the 2003 paper at SOSP \\
    1.54  ({\tt http://www.cl.cam.ac.uk/netos/papers/2003-xensosp.pdf}).
    1.55  The first public release of Xen (1.0) was made in October 2003.  Xen
    1.56  was developed as a research project by the University of Cambridge
    1.57 @@ -253,11 +253,11 @@ operating system distribution.
    1.58  \item A working installation of your favourite Linux distribution.
    1.59  \item A working installation of the GRUB bootloader.
    1.60  \item An installation of Twisted v1.3 or above (see {\tt
    1.61 -http://www.twistedmatrix.com}.  There may be a package available for
    1.62 +http://www.twistedmatrix.com}).  There may be a package available for
    1.63  your distribution; alternatively it can be installed by running {\tt \#
    1.64  make install-twisted} in the root of the Xen source tree.
    1.65  \item The Linux bridge control tools (see {\tt
    1.66 -http://bridge.sourceforge.net }).  There may be a packages of these
    1.67 +http://bridge.sourceforge.net}).  There may be a packages of these
    1.68  tools available for your distribution.
    1.69  \item Linux IP Routing Tools
    1.70  \item make
    1.71 @@ -277,9 +277,8 @@ for additional Xend logging functionalit
    1.72  
    1.73  \section{Install Bitkeeper (Optional)}
    1.74  
    1.75 -To fetch a local copy, first download the BitKeeper tools at: {\tt
    1.76 -http://www.bitmover.com/download } with username 'bitkeeper' and
    1.77 -password 'get bitkeeper'.
    1.78 +To fetch a local copy, first download the BitKeeper tools at: \\ {\tt
    1.79 +http://www.bitmover.com/download }
    1.80  
    1.81  The BitKeeper install program is designed to be run with X.  If X is
    1.82  not available, you can specify the install directory on the command
    1.83 @@ -327,10 +326,10 @@ The Xen source code repository is struct
    1.84  \item[\path{tools/}] Xen node controller daemon (Xend), command line tools, 
    1.85    control libraries
    1.86  \item[\path{xen/}] The Xen hypervisor itself.
    1.87 -\item[\path{linux-2.4.26-xen}] Linux 2.4 support for Xen
    1.88 -\item[\path{linux-2.6.7-xen}] Linux 2.6 support for Xen
    1.89 -\item[\path{doc}] various documentation files for users and developers
    1.90 -\item[\path{extras}] currently this contains the Mini OS, aimed at developers
    1.91 +\item[\path{linux-2.4.26-xen/}] Linux 2.4 support for Xen
    1.92 +\item[\path{linux-2.6.7-xen/}] Linux 2.6 support for Xen
    1.93 +\item[\path{doc/}] various documentation files for users and developers
    1.94 +\item[\path{extras/}] currently this contains the Mini OS, aimed at developers
    1.95  \end{description}
    1.96  
    1.97  \section{Build and install}
    1.98 @@ -355,12 +354,11 @@ more complicated. The makefile needs a `
    1.99  which it will then add the Xen architecture files to. You can tell the
   1.100  makefile the location of the appropriate linux compressed tar file by
   1.101  setting the LINUX\_SRC environment variable, e.g. \\
   1.102 -\verb!# LINUX\_SRC=/tmp/linux-2.4.26.tar.gz make world! \\
   1.103 -or by placing
   1.104 -the tar file somewhere in the search path of LINUX_SRC_PATH which
   1.105 -defaults to ".:..". If the makefile can't find a suitable kernel tar
   1.106 -file it attempts to download it from kernel.org (this won't work if
   1.107 -you're behind a firewall).
   1.108 +\verb!# LINUX\_SRC=/tmp/linux-2.4.26.tar.gz make world! \\ or by
   1.109 +placing the tar file somewhere in the search path of LINUX\_SRC\_PATH
   1.110 +which defaults to ``{\tt .:..}". If the makefile can't find a suitable
   1.111 +kernel tar file it attempts to download it from kernel.org (this won't
   1.112 +work if you're behind a firewall).
   1.113  
   1.114  After untaring the pristine kernel tree, the makefile uses the {\tt
   1.115  mkbuildtree} script to add the Xen patches the kernel. It then builds
   1.116 @@ -370,7 +368,7 @@ first virtual machine (``domain 0''), an
   1.117  extension that just contains virtual-device drivers.
   1.118  
   1.119  The procedure is similar to build the Linux 2.6 port: \\
   1.120 -\verb!LINUX\_SRC=/path/to/linux2.6/source make linux26!
   1.121 +\verb!# LINUX\_SRC=/path/to/linux2.6/source make linux26!
   1.122  
   1.123  In both cases, if you have an SMP machine you may wish to give the
   1.124  {\tt '-j4'} argument to make to get a parallel build.
   1.125 @@ -417,8 +415,8 @@ distribution.  The entry should look som
   1.126  
   1.127  \begin{verbatim}
   1.128  title Xen 2.0 / XenoLinux 2.4.26
   1.129 -        kernel /boot/xen.gz dom0_mem=131072 com1=115200,8n1
   1.130 -        module /boot/xenolinux.gz root=/dev/sda4 ro console=tty0 console=ttyS0
   1.131 +  kernel /boot/xen.gz dom0_mem=131072 com1=115200,8n1
   1.132 +  module /boot/xenolinux.gz root=/dev/sda4 ro console=tty0 console=ttyS0
   1.133  \end{verbatim}
   1.134  
   1.135  The first line of the configuration (kernel...) tells GRUB where to
   1.136 @@ -577,6 +575,7 @@ The output of {\tt xm list} is in rows o
   1.137    \item[c] crashed
   1.138    \end{description}
   1.139  \item[cputime] How much CPU time (in seconds) the domain has used so far.
   1.140 +\end{description}
   1.141  
   1.142  The {\tt xm list} command also supports a long output format when the
   1.143  {\tt -l} switch is used.  This outputs the fulls details of the
   1.144 @@ -1157,7 +1156,9 @@ mailing list (address below).
   1.145  
   1.146  For developers interested in porting operating systems to Xen, the
   1.147  {\em Xen Interface Manual} is distributed in the \path{docs/}
   1.148 -directory of the Xen source distribution.
   1.149 +directory of the Xen source distribution.  Various HOWTOs are
   1.150 +available in \path{docs/HOWTOS} but this content is being integrated
   1.151 +into this manual.
   1.152  
   1.153  \section{Online references}
   1.154  
   1.155 @@ -1176,9 +1177,10 @@ There are currently two official Xen mai
   1.156  \begin{description}
   1.157  \item[xen-devel@lists.sourceforge.net] Used for development
   1.158  discussions and requests for help.  Subscribe at: \\
   1.159 -http://lists.sourceforge.net/mailman/listinfo/xen-devel
   1.160 +{\tt http://lists.sourceforge.net/mailman/listinfo/xen-devel}
   1.161  \item[xen-announce@lists.sourceforge.net] Used for announcements only.
   1.162 -Subscribe at: \\ http://lists.sourceforge.net/mailman/listinfo/xen-announce
   1.163 +Subscribe at: \\
   1.164 +{\tt http://lists.sourceforge.net/mailman/listinfo/xen-announce}
   1.165  \end{description}
   1.166  
   1.167  Although there is no specific user support list, the developers try to