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

diff --git a/HACKING b/HACKING
index b2fab3e..df20e2d 100644
--- a/HACKING
+++ b/HACKING
@@ -1,3 +1,6 @@
+PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING TO SEE WHETHER IT
+IS AUTOMATICALLY GENERATED OR NOT.
+
 Adding a new action
 ----------------------------------------------------------------------
 
@@ -21,8 +24,62 @@ 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.
+
+	Also contains some files used by the test suite.
+
+java/
+	Java bindings.
+
+m4/
+	M4 macros used by autoconf.
+
+ocaml/
+	OCaml bindings.
+
+perl/
+	Perl bindings.
+
+python/
+	Python bindings.
+
+ruby/
+	Ruby 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