Update documentation.
authorRichard W.M. Jones <rjones@redhat.com>
Sun, 17 Aug 2008 15:53:05 +0000 (16:53 +0100)
committerRichard W.M. Jones <rjones@redhat.com>
Sun, 17 Aug 2008 15:53:05 +0000 (16:53 +0100)
HACKING
README

diff --git a/HACKING b/HACKING
index a9b1b71..610d976 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -50,19 +50,25 @@ which gets successively enhanced with extra data along the way:
        process, load kernel images
 
                |
-               |       (passes a 'Virt_mem_types.image0')
+               |
                V
 
        Find kernel symbols
 
                |
-               |       (enhanced into a 'Virt_mem_types.image1')
+               |
                V
 
        Find kernel version (uname)
 
                |
-               |       (enhanced into a 'Virt_mem_types.image2')
+               |
+               V
+
+       Find task_structs, net_devices, etc.
+
+               |
+               |
                V
 
        Call tool's "run" function.
diff --git a/README b/README
index 6fbe3c1..83d4022 100644 (file)
--- a/README
+++ b/README
@@ -10,6 +10,7 @@ Commands we support at the moment include:
   virt-uname      'uname' command, shows OS version, architecture, etc.
   virt-dmesg      'dmesg' command, shows kernel messages
   virt-ps         'ps' command, shows process list
+  virt-ifconfig   'ifconfig' command, shows network interfaces, addresses, etc.
 
 The general idea is that they allow you to monitor virtual machines
 without needing to log in to the machine itself or install any extra
@@ -21,6 +22,9 @@ The commands use libvirt to access the underlying virtualization
 system, so we support a variety of different systems such as Xen, QEMU
 and KVM, and more can be added just by adding support to libvirt.
 
+THIS IS HIGHLY EXPERIMENTAL, ALPHA-QUALITY SOFTWARE.  PLEASE READ THE FAQ:
+http://et.redhat.com/~rjones/virt-mem/faq.html
+
 
 Website
 ----------------------------------------------------------------------