Manual page with centralised documentation.
[virt-p2v.git] / README.developers
index ac1f8e9..232805e 100644 (file)
@@ -1,5 +1,3 @@
-$Id$
-
 Background reading
 ----------------------------------------------------------------------
 
@@ -23,15 +21,10 @@ livecd-post.sh.in
   before the live CD is turned into an ISO.  The shell script creates
   any extra files we need on the live CD.
 
-p2v.init
-
-  This is installed on the live CD as /etc/init.d/p2v, and it causes the
-  live CD to boot into the P2V configuration tool (see next).
-
-virt-p2v.sh
+virt-p2v
 
-  This is the virt-p2v.sh P2V configuration tool itself.  It is
-  installed on the live CD as /usr/bin/virt-p2v.sh and runs after the
+  This is the virt-p2v P2V configuration tool itself.  It is
+  installed on the live CD as /usr/bin/virt-p2v and runs after the
   live CD has booted.  All the P2V stuff happens from this script. It
   uses the 'dialog' program to ask questions.
 
@@ -39,6 +32,10 @@ inittab
 
   Replacement /etc/inittab.
 
+iso-attach
+
+  Attach newer virt-p2v scripts to pre-built ISOs (used by 'make update').
+
 General implementation plan
 ----------------------------------------------------------------------
 
@@ -63,25 +60,9 @@ for devices in /sys/block.
 For (b) we can simply use 'dd' and 'ssh'.  The general plan is to do
 this:
 
-  dd if=/dev/disk | gzip | ssh xenhost 'zcat > /var/lib/xen/images/disk.img'
-
-If the user doesn't have sshd installed on the Xen host, then they can
-also opt for a pure TCP transport:
-
-  dd if=/dev/disk | gzip | nc xenhost port
-
-  and on the remote host they do:
-  nc -l port > /var/lib/xen/images/disks.gz
+  dd if=/dev/disk | ssh -C xenhost 'cat > /var/lib/xen/images/disk.img'
 
 For (c) we can use device-mapper snapshots to mount a ramdisk above
 the disks themselves.  This allows us to make non-destructive changes
 to files, and still see the "modified" block device (d).  A hairy
-shell script looks for candidate files to modify.
-
-Non-generic virt-p2v
-----------------------------------------------------------------------
-
-The above describes the generic virt-p2v, which asks users questions
-after boot.  It is also possible to build your own live CD, based on
-virt-p2v, which has various settings compiled in so it runs
-automatically.
+script looks for candidate files to modify.