summaryrefslogtreecommitdiffstats
path: root/HACKING
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-04-07 13:08:50 +0100
committerRichard Jones <rjones@redhat.com>2009-04-07 13:08:50 +0100
commitacf9000252da7f4f3fde693ecc03461007cf0bf9 (patch)
treebe2a75846b3b28aa781f47f2ab9419fe833f05ee /HACKING
parentdfb90f793a40d38da47ee1b604ed0a73a05281d0 (diff)
downloadlibguestfs-acf9000252da7f4f3fde693ecc03461007cf0bf9.tar.gz
libguestfs-acf9000252da7f4f3fde693ecc03461007cf0bf9.tar.xz
libguestfs-acf9000252da7f4f3fde693ecc03461007cf0bf9.zip
Added framework for the language bindings.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING39
1 files changed, 38 insertions, 1 deletions
diff --git a/HACKING b/HACKING
index cdcca689..e0b0f0f1 100644
--- a/HACKING
+++ b/HACKING
@@ -15,6 +15,9 @@ 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
----------------------------------------------------------------------
@@ -23,11 +26,45 @@ 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.
+
+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.
+
Use 'guestfish -v', which will show error messages etc from the
daemon.