Fix dependencies in perl so it doesn't always rebuild

[libguestfs.git] / HACKING

diff --git a/HACKING b/HACKING
index 2d3f216..fc9ed38 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
 ----------------------------------------------------------------------
 
@@ -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,15 @@ Please test any changes.
 Directories
 ----------------------------------------------------------------------
 
+appliance/
+       The qemu appliance, build scripts and so on.
+
+capitests/
+       Automated tests of the C API.
+
+contrib/
+       Outside contributions, experimental parts.
+
 daemon/
        The daemon that runs inside the guest and carries out actions.
 
@@ -40,22 +49,42 @@ 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.
 
 ocaml/
        OCaml bindings.
 
+po/
+       Translations.
+
 perl/
        Perl bindings.
 
 python/
        Python bindings.
 
+regressions/
+       Regression tests.
+
+ruby/
+       Ruby bindings.
+
 src/
        Source code to the C library.
        Also contains the crucial generator program.
@@ -75,3 +104,17 @@ Patches
 Submit patches to the fedora-virt mailing list:
 http://www.redhat.com/mailman/listinfo/fedora-virt
 and CC to rjones@redhat.com
+
+I18N
+----------------------------------------------------------------------
+
+We support i18n (gettext anyhow) in the library.
+
+However many messages come from the daemon, and we don't translate
+those at the moment.  One reason is that the appliance generally has
+all locale files removed from it, because they take up a lot of space.
+So we'd have to readd some of those, as well as copying our PO files
+into the appliance.
+
+Debugging messages are never translated, since they are intended for
+the programmers.