debuggers.hg

changeset 20671:b928797213ac

docs: Fixes for README

Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
author Keir Fraser <keir.fraser@citrix.com>
date Fri Dec 11 09:17:09 2009 +0000 (2009-12-11)
parents 90a6dd880ddf
children 2d072636c4f8
files README
line diff
     1.1 --- a/README	Fri Dec 11 09:07:57 2009 +0000
     1.2 +++ b/README	Fri Dec 11 09:17:09 2009 +0000
     1.3 @@ -1,10 +1,10 @@
     1.4  #################################
     1.5 - __  __            _____ _  _   
     1.6 - \ \/ /___ _ __   |___ /| || |  
     1.7 -  \  // _ \ '_ \    |_ \| || |_ 
     1.8 -  /  \  __/ | | |  ___) |__   _|
     1.9 - /_/\_\___|_| |_| |____(_) |_|  
    1.10 -                                 
    1.11 + __  __            _  _    ___  
    1.12 + \ \/ /___ _ __   | || |  / _ \ 
    1.13 +  \  // _ \ '_ \  | || |_| | | |
    1.14 +  /  \  __/ | | | |__   _| |_| |
    1.15 + /_/\_\___|_| |_|    |_|(_)___/ 
    1.16 +
    1.17  #################################
    1.18  
    1.19  http://www.xen.org/
    1.20 @@ -17,14 +17,12 @@ Systems Research Group of the University
    1.21  Laboratory, as part of the UK-EPSRC funded XenoServers project.  Xen
    1.22  is freely-distributable Open Source software, released under the GNU
    1.23  GPL. Since its initial public release, Xen has grown a large
    1.24 -development community, spearheaded by XenSource Inc, a company created
    1.25 -by the original Xen development team to build enterprise products
    1.26 -around Xen.
    1.27 +development community, spearheaded by xen.org (http://www.xen.org).
    1.28  
    1.29 -The 3.4 release offers excellent performance, hardware support and
    1.30 +The 4.0 release offers excellent performance, hardware support and
    1.31  enterprise-grade features such as x86_32-PAE, x86_64, SMP guests and
    1.32 -live relocation of VMs. Ports to Linux 2.6, Linux 2.4, NetBSD, FreeBSD
    1.33 -and Solaris are available from the community.
    1.34 +live relocation of VMs. Ports to Linux, NetBSD, FreeBSD and Solaris
    1.35 +are available from the community.
    1.36  
    1.37  This file contains some quick-start instructions to install Xen on
    1.38  your system. For full documentation, see the Xen User Manual. If this
    1.39 @@ -33,53 +31,8 @@ is a pre-built release then you can find
    1.40  If you have a source release, then 'make -C docs' will build the
    1.41  manual at docs/pdf/user.pdf.
    1.42  
    1.43 -Quick-Start Guide - Pre-Built Binary Release
    1.44 -============================================
    1.45 -
    1.46 -[NB. Unless noted otherwise, all the following steps should be
    1.47 -performed with root privileges.]
    1.48 -
    1.49 -1. Install the binary distribution onto your filesystem:
    1.50 -
    1.51 -    # sh ./install.sh
    1.52 -
    1.53 -   Among other things, this will install Xen and Xen-ready Linux
    1.54 -   kernel files in /boot, kernel modules and Python packages in /lib,
    1.55 -   and various control tools in standard 'bin' directories.
    1.56 -
    1.57 -2. Configure your bootloader to boot Xen and an initial Linux virtual
    1.58 -   machine. Note that Xen currently only works with GRUB and pxelinux
    1.59 -   derived boot loaders: less common alternatives such as LILO are
    1.60 -   *not* supported. You can most likely find your GRUB menu file at
    1.61 -   /boot/grub/menu.lst: edit this file to include an entry like the
    1.62 -   following:
    1.63 -
    1.64 -    title Xen 3.4 / XenLinux 2.6
    1.65 -       kernel /boot/xen-3.4.gz console=vga
    1.66 -       module /boot/vmlinuz-2.6-xen root=<root-dev> ro console=tty0
    1.67 -       module /boot/initrd-2.6-xen.img
    1.68 -
    1.69 -   NB: Not all kernel configs need an initial ram disk (initrd), but
    1.70 -   if you do specify one you'll need to use the 'module' grub directive
    1.71 -   rather than 'initrd'.
    1.72 -
    1.73 -   The linux command line takes all the usual options, such as
    1.74 -   root=<root-dev> to specify your usual root partition (e.g.,
    1.75 -   /dev/hda1).
    1.76 -
    1.77 -   The Xen command line takes a number of optional arguments described
    1.78 -   in the manual. The most common is 'dom0_mem=xxxM' which sets the
    1.79 -   amount of memory to allocate for use by your initial virtual
    1.80 -   machine (known as domain 0). Note that Xen itself reserves about
    1.81 -   32MB memory for internal use, which is not available for allocation
    1.82 -   to virtual machines.
    1.83 -
    1.84 -3. Reboot your system and select the "Xen 3.4 / XenLinux 2.6" menu
    1.85 -   option. After booting Xen, Linux will start and your initialisation
    1.86 -   scripts should execute in the usual way.
    1.87 -
    1.88 -Quick-Start Guide - Source Release
    1.89 -==================================
    1.90 +Quick-Start Guide
    1.91 +=================
    1.92  
    1.93  First, there are a number of prerequisites for building a Xen source
    1.94  release. Make sure you have all the following installed, either by