Implement 'strings' and 'hexdump' commands.

[libguestfs.git] / HACKING

diff --git a/HACKING b/HACKING
index e0b0f0f..f77defe 100644 (file)
--- 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
 ----------------------------------------------------------------------
 
 Adding a new action
 ----------------------------------------------------------------------
 


@@ -15,9 +18,6 @@ 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.
 
 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
 ----------------------------------------------------------------------
 
 Formatting
 ----------------------------------------------------------------------
 


@@ -44,6 +44,14 @@ images/
        Some guest images to test against.  These are gzipped to save
        space.  You have to unzip them before use.
 
        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.
 
 m4/
        M4 macros used by autoconf.
 


@@ -56,6 +64,9 @@ perl/
 python/
        Python bindings.
 
 python/
        Python bindings.
 

+ruby/
+       Ruby bindings.
+

 src/
        Source code to the C library.
        Also contains the crucial generator program.
 src/
        Source code to the C library.
        Also contains the crucial generator program.


@@ -65,8 +76,9 @@ Debugging
 
 It's a good idea to use guestfish to try out new commands.
 
 
 It's a good idea to use guestfish to try out new commands.
 

-Use 'guestfish -v', which will show error messages etc from the
-daemon.
+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
 ----------------------------------------------------------------------
 
 Patches
 ----------------------------------------------------------------------