X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=HACKING;h=8ad6e9a79d946a33b121d94a30bb8a02f3d44581;hb=1eeaf2ea11a502bae686fde753b31a72e700a3ba;hp=e0b0f0f167c37e33fc7bec1b2d50c911d9a8b698;hpb=acf9000252da7f4f3fde693ecc03461007cf0bf9;p=libguestfs.git diff --git a/HACKING b/HACKING index e0b0f0f..8ad6e9a 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 ---------------------------------------------------------------------- @@ -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. -PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING to see whether it -is automatically generated or not. - Formatting ---------------------------------------------------------------------- @@ -31,6 +31,9 @@ Please test any changes. Directories ---------------------------------------------------------------------- +contrib/ + Outside contributions, experimental parts. + daemon/ The daemon that runs inside the guest and carries out actions. @@ -40,10 +43,21 @@ examples/ fish/ Guestfish (the command-line program / shell) +haskell/ + Haskell bindings. + 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. @@ -56,6 +70,9 @@ perl/ python/ Python bindings. +ruby/ + Ruby bindings. + src/ Source code to the C library. Also contains the crucial generator program. @@ -65,8 +82,9 @@ Debugging 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 ----------------------------------------------------------------------