X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=f77defef66818817e587bb59cdd938868644b3f2;hp=cdcca6893962087cc43445cdec6441d8df1ae68f;hb=41b959fd9b057354f642d84398b875d02b88b864;hpb=bf17bf81fef275892d24458ce5f1e5290b426742

diff --git a/HACKING b/HACKING
index cdcca68..f77defe 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
 ----------------------------------------------------------------------
 
@@ -23,13 +26,59 @@ used elsewhere in the source.
 
 Please make sure that the code compiles without warnings.
 
-Please test any changes
+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.
+
+inspector/
+	Virtual machine image inspector (virt-inspector).
+
+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
 ----------------------------------------------------------------------
 
-Use 'guestfish -v', which will show error messages etc from the
-daemon.
+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
 ----------------------------------------------------------------------