X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=336fc7c667941e8a78e481f58810872f62e6c083;hp=4e6ac4cecc3b9017f9d47482acb2e2e2b24eb32d;hb=bf2b08560f649c22152e4138531ad0b46b4ad1b3;hpb=d70248333edf8a5b5f509609cf2c8f7fd77d5e05

diff --git a/HACKING b/HACKING
index 4e6ac4c..336fc7c 100644
--- a/HACKING
+++ b/HACKING
@@ -14,10 +14,6 @@ etc. to the big list called 'functions' at the top of this file.
 'do_action' function.  Take a look at one of the numerous examples
 there.
 
-You will need to run src/generator.ml (from the top directory) which
-regenerates all the auto-generated files, and then continue with the
-ordinary build process.
-
 Formatting
 ----------------------------------------------------------------------
 
@@ -31,12 +27,24 @@ Please test any changes.
 Directories
 ----------------------------------------------------------------------
 
+appliance/
+	The qemu appliance, build scripts and so on.
+
+cat/
+	The virt-cat tool.
+
+capitests/
+	Automated tests of the C API.
+
 contrib/
 	Outside contributions, experimental parts.
 
 daemon/
 	The daemon that runs inside the guest and carries out actions.
 
+df/
+	The virt-df tool.
+
 examples/
 	The examples.
 
@@ -73,6 +81,9 @@ perl/
 python/
 	Python bindings.
 
+regressions/
+	Regression tests.
+
 ruby/
 	Ruby bindings.
 
@@ -80,6 +91,12 @@ src/
 	Source code to the C library.
 	Also contains the crucial generator program.
 
+test-tool/
+	Interactive qemu/kernel test tool.
+
+v2v/
+	Xen to KVM (V2V) conversion tool.
+
 Debugging
 ----------------------------------------------------------------------
 
@@ -92,8 +109,8 @@ they will show up if you use 'guestfish -v'.
 Patches
 ----------------------------------------------------------------------
 
-Submit patches to the fedora-virt mailing list:
-http://www.redhat.com/mailman/listinfo/fedora-virt
+Submit patches to the mailing list:
+http://www.redhat.com/mailman/listinfo/libguestfs
 and CC to rjones@redhat.com
 
 I18N
@@ -109,3 +126,25 @@ into the appliance.
 
 Debugging messages are never translated, since they are intended for
 the programmers.
+
+Extended printf
+----------------------------------------------------------------------
+
+In the daemon code we have created custom printf formatters %Q and %R,
+which are used to do shell quoting.
+
+%Q => Simple shell quoted string.  Any spaces or other shell characters
+      are escaped for you.
+
+%R => Same as %Q except the string is treated as a path which is prefixed
+      by the sysroot.
+
+eg.
+
+asprintf (&cmd, "cat %R", path);
+==> "cat /sysroot/some\ path\ with\ spaces"
+
+Note: Do NOT use these when you are passing parameters to the
+command{,r,v,rv}() functions.  These parameters do NOT need to be
+quoted because they are not passed via the shell (instead, straight to
+exec).  You probably want to use the sysroot_path() function however.