X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=HACKING;h=2d3f216f4a404d78d2ecd8affce4b6fc81798fa7;hb=c989e8832df70b4cb8200ba8d5622048e560f1f7;hp=b2fab3ed28ca4869b14a1b1cb414c17bda269e4d;hpb=f5d2602bf6d40ecc71a5a17e0be9f480e9a4453a;p=libguestfs.git

diff --git a/HACKING b/HACKING
index b2fab3e..2d3f216 100644
--- a/HACKING
+++ b/HACKING
@@ -15,14 +15,63 @@ 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.
 
+PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING to see whether it
+is automatically generated or not.
+
 Formatting
 ----------------------------------------------------------------------
 
 Try to use GNU / Emacs default formatting, following the convention
 used elsewhere in the source.
 
+Please make sure that the code compiles without warnings.
+
+Please test any changes.
+
+Directories
+----------------------------------------------------------------------
+
+daemon/
+	The daemon that runs inside the guest and carries out actions.
+
+examples/
+	The examples.
+
+fish/
+	Guestfish (the command-line program / shell)
+
+images/
+	Some guest images to test against.  These are gzipped to save
+	space.  You have to unzip them before use.
+
+m4/
+	M4 macros used by autoconf.
+
+ocaml/
+	OCaml bindings.
+
+perl/
+	Perl bindings.
+
+python/
+	Python bindings.
+
+src/
+	Source code to the C library.
+	Also contains the crucial generator program.
+
+Debugging
+----------------------------------------------------------------------
+
+It's a good idea to use guestfish to try out new commands.
+
+Debugging the daemon is a problem because it runs inside a minimal
+qemu environment.  However you can print messages from the daemon, and
+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
+and CC to rjones@redhat.com