bitkeeper revision 1.945 (40c72fd2I_g1_WTlzwSBghpabzfPew)

Documentation updates.

6 files changed, 52 insertions, 17 deletions

diff --git a/.rootkeys b/.rootkeys
index 65327c9853..4afcd88ced 100644
--- a/.rootkeys
+++ b/.rootkeys
@@ -6,15 +6,15 @@
 3f5ef5a24IaQasQE2tyMxrfxskMmvw README
 3f5ef5a2l4kfBYSQTUaOyyD76WROZQ README.CD
 3f69d8abYB1vMyD_QVDvzxy5Zscf1A TODO
-405ef604hIZH5pGi2uwlrlSvUMrutw docs/Console-HOWTO.txt
+405ef604hIZH5pGi2uwlrlSvUMrutw docs/HOWTOs/Console-HOWTO
+4083e798FbE1MIsQaIYvjnx1uvFhBg docs/HOWTOs/Sched-HOWTO
+40083bb4LVQzRqA3ABz0__pPhGNwtA docs/HOWTOs/VBD-HOWTO
+4021053fmeFrEyPHcT8JFiDpLNgtHQ docs/HOWTOs/Xen-HOWTO
+4022a73cgxX1ryj1HgS-IwwB6NUi2A docs/HOWTOs/XenDebugger-HOWTO
 3f9e7d53iC47UnlfORp9iC1vai6kWw docs/Makefile
-4083e798FbE1MIsQaIYvjnx1uvFhBg docs/Sched-HOWTO.txt
-40083bb4LVQzRqA3ABz0__pPhGNwtA docs/VBD-HOWTO.txt
-4021053fmeFrEyPHcT8JFiDpLNgtHQ docs/Xen-HOWTO.txt
 3f9e7d60PWZJeVh5xdnk0nLUdxlqEA docs/eps/xenlogo.eps
 3f9e7d63lTwQbp2fnx7yY93epWS-eQ docs/figs/dummy
 3f9e7d564bWFB-Czjv1qdmE6o0GqNg docs/interface.tex
-4022a73cgxX1ryj1HgS-IwwB6NUi2A docs/pdb.txt
 3f9e7d58t7N6hjjBMxSn-NMxBphchA docs/style.tex
 3f9e7d5bz8BwYkNuwyiPVu7JJG441A docs/xenstyle.cls
 3f815144d1vI2777JI-dO4wk49Iw7g extras/mini-os/Makefile
diff --git a/docs/Console-HOWTO.txt b/docs/HOWTOs/Console-HOWTO
index 4abdf52921..4abdf52921 100644
--- a/docs/Console-HOWTO.txt
+++ b/docs/HOWTOs/Console-HOWTO
diff --git a/docs/Sched-HOWTO.txt b/docs/HOWTOs/Sched-HOWTO
index 42d6238f17..42d6238f17 100644
--- a/docs/Sched-HOWTO.txt
+++ b/docs/HOWTOs/Sched-HOWTO
diff --git a/docs/VBD-HOWTO.txt b/docs/HOWTOs/VBD-HOWTO
index b6feb104c2..b6feb104c2 100644
--- a/docs/VBD-HOWTO.txt
+++ b/docs/HOWTOs/VBD-HOWTO
diff --git a/docs/Xen-HOWTO.txt b/docs/HOWTOs/Xen-HOWTO
index 7fe5842bd3..ed990c9b4b 100644
--- a/docs/Xen-HOWTO.txt
+++ b/docs/HOWTOs/Xen-HOWTO
@@ -12,6 +12,8 @@ Get Xen Source Code
 
 The public master BK repository for the 1.2 release lives at:
 'bk://xen.bkbits.net/xeno-1.2.bk'
+The current unstable release (1.3) is available at:
+'bk://xen.bkbits.net/xeno-unstable.bk'
 
 To fetch a local copy, first download the BitKeeper tools at:
 http://www.bitmover.com/download with username 'bitkeeper' and
@@ -29,6 +31,39 @@ To get newest changes to the repository, run
 # bk pull
 
 
+Configuring Xen
+=============================
+
+Xen's build configuration is managed via a set of environment
+variables. These should be set before invoking make 
+(e.g., 'export debug=y; make', 'debug=y make').
+
+The options that can be configured are as follows (all options default
+to 'n' or off):
+
+ debug=y    -- Enable debug assertions and console output.
+               (Primarily useful for tracing bugs in Xen).
+
+ debugger=y -- Enable the in-Xen pervasive debugger (PDB).
+               This can be used to debug Xen, guest OSes, and
+               applications. For more information see the 
+               XenDebugger-HOWTO.
+
+ old_drivers=y -- Enable the old hardware-device architecture, in
+               which network and block devices are managed by
+               Xen. The new (and default) model requires such
+               devices to be managed by a suitably-privileged
+               guest OS (e.g., within domain 0).
+
+ perfc=y    -- Enable performance-counters for significant events
+               within Xen. The counts can be reset or displayed
+               on Xen's console via console control keys.
+
+ trace=y    -- Enable per-cpu trace buffers which log a range of
+               events within Xen for collection by control
+               software.
+
+
 Build Xen
 =============================
 
@@ -64,16 +99,16 @@ kernel source tree. It contains only those files currently 'in play'
 which are either modified versions of files in the vanilla linux tree,
 or brand new files specific to the Xen port.
 
-So, first you need a vanilla linux-2.4.24 tree, which is located at:
+So, first you need a vanilla linux-2.4.26 tree, which is located at:
 http://www.kernel.org/pub/linux/kernel/v2.4
 
 Then:
-  # mv linux-2.4.24.tar.gz /xeno-1.2.bk
+  # mv linux-2.4.26.tar.gz /xeno-1.2.bk
   # cd /xeno-1.2.bk
-  # tar -zxvf linux-2.4.24.tar.gz
+  # tar -zxvf linux-2.4.26.tar.gz
 
-You'll find a new directory 'linux-2.4.24' which contains all
-the vanilla Linux 2.4.24 kernel source codes.
+You'll find a new directory 'linux-2.4.26' which contains all
+the vanilla Linux 2.4.26 kernel source codes.
 
 Hint: You should choose the vanilla linux kernel tree that has the
 same version as the "sparse" tree.
@@ -81,26 +116,26 @@ same version as the "sparse" tree.
 Next, you need to 'overlay' this sparse tree on the full vanilla Linux
 kernel tree:
 
-  # cd /xeno-1.2.bk/xenolinux-2.4.24-sparse
-  # ./mkbuildtree ../linux-2.4.24
+  # cd /xeno-1.2.bk/xenolinux-2.4.26-sparse
+  # ./mkbuildtree ../linux-2.4.26
 
 Finally, rename the buildtree since it is now a 'xenolinux' buildtree. 
 
   # cd /xeno-1.2.bk
-  # mv linux-2.4.24 xenolinux-2.4.24
+  # mv linux-2.4.26 xenolinux-2.4.26
 
 Now that the buildtree is there, you can build the xenolinux kernel.
 The default configuration should work fine for most people (use 'make
 oldconfig') but you can customise using one of the other config tools
 if you want.
 
-  # cd /xeno-1.2.bk/xenolinux-2.4.24
+  # cd /xeno-1.2.bk/xenolinux-2.4.26
   # ARCH=xen make oldconfig   { or menuconfig, or xconfig, or config }  
   # ARCH=xen make dep
   # ARCH=xen make bzImage
 
 Assuming the build works, you'll end up with
-/xeno-1.2.bk/xenolinux-2.4.24/arch/xen/boot/xenolinux.gz. This is the
+/xeno-1.2.bk/xenolinux-2.4.26/arch/xen/boot/xenolinux.gz. This is the
 gzip version of XenoLinux kernel image.
 
 
@@ -149,14 +184,14 @@ Installation
 
 First:
 # cp /xen-1.2.bk/xen/xen.gz /boot/xen.gz
-# cp /xen-1.2.bk/xenolinux-2.4.24/arch/xen/boot/xenolinux.gz /boot/xenolinux.gz
+# cp /xen-1.2.bk/xenolinux-2.4.26/arch/xen/boot/xenolinux.gz /boot/xenolinux.gz
 
 Second, you must have 'GNU Grub' installed. Then you need to edit
 the Grub configuration file '/boot/grub/menu.lst'.
 
 A typical Grub menu option might look like:
 
-title Xen 1.2 / XenoLinux 2.4.24
+title Xen 1.2 / XenoLinux 2.4.26
         kernel /boot/xen.gz dom0_mem=131072 com1=115200,8n1 noht
         module /boot/xenolinux.gz root=/dev/sda4 ro console=tty0
 
diff --git a/docs/pdb.txt b/docs/HOWTOs/XenDebugger-HOWTO
index 8d5dc69e69..8d5dc69e69 100644
--- a/docs/pdb.txt
+++ b/docs/HOWTOs/XenDebugger-HOWTO