[Pkg-libvirt-commits] [libguestfs] 39/146: p2v: Add HACKING file.

[Hilko Bengen]

This is an automated email from the git hooks/post-receive script.

bengen pushed a commit to branch master
in repository libguestfs.

commit 197dff34aaa76f67df134e22fbd46659a2350884
Author: Richard W.M. Jones <rjones at redhat.com>
Date:   Thu Nov 27 14:39:31 2014 +0000

    p2v: Add HACKING file.
    
    (cherry picked from commit 3d3694610fc353ae28c9cf88ff105a04da108c4a)
---
 p2v/HACKING | 36 ++++++++++++++++++++++++++++++++++++
 v2v/HACKING | 11 ++---------
 2 files changed, 38 insertions(+), 9 deletions(-)

diff --git a/p2v/HACKING b/p2v/HACKING
new file mode 100644
index 0000000..a796aa7
--- /dev/null
+++ b/p2v/HACKING
@@ -0,0 +1,36 @@
+To see about hacking on virt-v2v, see v2v/HACKING.
+
+Virt-p2v is a front end on virt-v2v.  ie. All it does is act as a GUI
+front end, and it calls out to virt-v2v to perform the actual
+conversion.  Therefore most of the C code in the p2v/ subdirectory is
+Gtk (GUI) code, or supporting code for talking to the remote
+conversion server.  There is no special support for physical machines
+in virt-v2v.  They are converted in the same way as foreign VMs.
+
+There are two paths through the code, GUI or non-GUI (parsing the
+kernel command line):
+
+  main.c     --+---->   gui.c    -----+----> conversion.c
+               |                      |
+               |                      |
+               `---->  kernel.c  -----'
+
+but both paths call back to the conversion.c function
+'start_conversion' to run the remote virt-v2v.
+
+The main task of gui.c/kernel.c is to populate the virt-v2v
+configuration (config.c).
+
+During conversion, we need to establish ssh connections, and that is
+done using two libraries:
+
+  conversion.c  ------>  ssh.c  ------>  miniexpect.c
+
+where 'ssh.c' is responsible for managing ssh connections overall, and
+'miniexpect.c' implements "expect-like" functionality for talking
+interactively to the remote virt-v2v conversion server.
+
+(Note that miniexpect is a separate library with its own upstream, so
+if you patch miniexpect.c, then please make sure the changes get
+reflected in miniexpect's upstream too:
+http://git.annexia.org/?p=miniexpect.git;a=summary )
diff --git a/v2v/HACKING b/v2v/HACKING
index 1611533..1825984 100644
--- a/v2v/HACKING
+++ b/v2v/HACKING
@@ -1,5 +1,5 @@
-If you want to hack on virt-v2v or virt-p2v, you've come to the right
-place ...
+If you want to hack on virt-v2v, you've come to the right place ...
+For virt-p2v, read this file, but also p2v/HACKING.
 
 First a little history.  Virt-v2v has been through at least two
 complete rewrites, so this is probably about the third version (but we
@@ -32,10 +32,3 @@ them.
 Every other file in this directory is a support module / library of
 some sort.  Some code is written in C, especially where we want to use
 an external C library such as libxml2.
-
-Virt-p2v is a front end on virt-v2v.  ie. All it does is act as a GUI
-front end, and it calls out to virt-v2v to perform the actual
-conversion.  Therefore most of the C code in the p2v/ subdirectory is
-Gtk (GUI) code, or supporting code for talking to the remote
-conversion server.  There is no special support for physical machines
-in virt-v2v.  They are converted in the same way as foreign VMs.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-libvirt/libguestfs.git