Add .gitignore file for git.

[virt-p2v.git] / README.developers

diff --git a/README.developers b/README.developers
index 784504a..0cadb53 100644 (file)
--- a/README.developers
+++ b/README.developers
@@ -1,4 +1,17 @@
-$Id$
+Support
+----------------------------------------------------------------------
+
+Please send all queries, patches, bug reports etc. to the
+et-mgmt-tools mailing list:
+
+  http://www.redhat.com/mailman/listinfo/et-mgmt-tools
+
+Source repository
+----------------------------------------------------------------------
+
+If you have Mercurial installed, then:
+
+  hg clone http://hg.et.redhat.com/virt/applications/virt-p2v--devel

 
 Background reading
 ----------------------------------------------------------------------
 
 Background reading
 ----------------------------------------------------------------------


@@ -10,34 +23,46 @@ About Live CDs / livecd-creator tool:
 The files in this directory
 ----------------------------------------------------------------------
 
 The files in this directory
 ----------------------------------------------------------------------
 

-livecd.ks.in
+p2v.ks.in

 
   Kickstart file which describes how to build the live CD.  This is
   essentially the configuration file for livecd-creator.  Most
   importantly it lists the RPMs which are needed on the live CD.
 
 
   Kickstart file which describes how to build the live CD.  This is
   essentially the configuration file for livecd-creator.  Most
   importantly it lists the RPMs which are needed on the live CD.
 

-livecd-post.sh.in
+virt-p2v

 
 

-  This is the %post-configuration section of the Kickstart script.  It
-  is a shell script which runs after the RPMs have been installed but
-  before the live CD is turned into an ISO.  The shell script creates
-  any extra files we need on the live CD.
+  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.

 
 

-p2v.init
+inittab

 
 

-  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).
+  Replacement /etc/inittab (for init-based systems).

 
 

-virt-p2v.sh
+tty1

 
 

-  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
-  live CD has booted.  All the P2V stuff happens from this script. It
-  uses the 'dialog' program to ask questions.
+  Replacement /etc/event.d/tty1 (for upstart-based systems).

 
 

-inittab

 
 

-  Replacement /etc/inittab.
+iso-attach
+
+  Attach newer virt-p2v scripts to pre-built ISOs (used by 'make update').
+
+extras/
+
+  Anything under here is copied onto the ISO squashfs.  In particular
+  this contains paravirt drivers for Red Hat Enterprise Linux,
+  CentOS and friends.
+
+Tips for OCaml
+----------------------------------------------------------------------
+
+All the packages you need are in Fedora and Debian.
+
+If using emacs, make sure you install tuareg-mode (the editing mode
+for OCaml).  Unfortunately there is no Fedora package for it at the
+moment, but it is very easy to install.

 
 General implementation plan
 ----------------------------------------------------------------------
 
 General implementation plan
 ----------------------------------------------------------------------


@@ -63,25 +88,9 @@ for devices in /sys/block.
 For (b) we can simply use 'dd' and 'ssh'.  The general plan is to do
 this:
 
 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 -kl port > /var/lib/xen/images/disks
+  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
 
 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.