X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=42f0f3aa13d26bb699f139b6abaa0067f6f745bf;hp=c6a302278970d20e9370d8b7d6de4356ebc7c2a6;hb=fab75c0337d7897d10ea5e95e47ac05eab81ace9;hpb=2f1a50d81671810256dce0852e6b1e0810ac44af

diff --git a/HACKING b/HACKING
index c6a3022..42f0f3a 100644
--- a/HACKING
+++ b/HACKING
@@ -7,8 +7,8 @@ Adding a new action
 All action functions are generated automatically, so there are only
 two files you need to edit:
 
-(1) src/generator.ml: Add your new action, parameters, description,
-etc. to the big list called 'functions' at the top of this file.
+(1) generator/generator_actions.ml: Add your new action, parameters,
+description, etc. to the big list at the top of this file.
 
 (2) Edit/create a C file in daemon/ subdirectory which implements your
 'do_action' function.  Take a look at one of the numerous examples
@@ -24,36 +24,87 @@ Please make sure that the code compiles without warnings.
 
 Please test any changes.
 
+Useful targets:
+  make syntax-check    Checks the syntax of the C code.
+  make check           Runs the test suite.
+
+Enable warnings, and fix any you find:
+  ./configure --enable-gcc-warnings
+
+Code indentation
+----------------------------------------------------------------------
+Our C source code generally adheres to some basic code-formatting
+conventions.  The existing code base is not totally consistent on this
+front, but we do prefer that contributed code be formatted similarly.
+In short, use spaces-not-TABs for indentation, use 2 spaces for each
+indentation level, and other than that, follow the K&R style.
+
+If you use Emacs, add the following to one of one of your start-up files
+(e.g., ~/.emacs), to help ensure that you get indentation right:
+
+  ;;; In libguestfs, indent with spaces everywhere (not TABs).
+  ;;; Exceptions: Makefile and ChangeLog modes.
+  (add-hook 'find-file-hook
+      '(lambda () (if (and buffer-file-name
+                           (string-match "/libguestfs\\>" (buffer-file-name))
+                           (not (string-equal mode-name "Change Log"))
+                           (not (string-equal mode-name "Makefile")))
+                      (setq indent-tabs-mode nil))))
+
+  ;;; When editing C sources in libguestfs, use this style.
+  (defun libguestfs-c-mode ()
+    "C mode with adjusted defaults for use with libguestfs."
+    (interactive)
+    (c-set-style "K&R")
+    (setq c-indent-level 2)
+    (setq c-basic-offset 2))
+  (add-hook 'c-mode-hook
+            '(lambda () (if (string-match "/libguestfs\\>" (buffer-file-name))
+                            (libguestfs-c-mode))))
+
 Directories
 ----------------------------------------------------------------------
 
 appliance/
         The qemu appliance, build scripts and so on.
 
-cat/
-        The virt-cat tool.
-
 capitests/
         Automated tests of the C API.
 
+cat/
+        The 'virt-cat' command and documentation.
+
 contrib/
         Outside contributions, experimental parts.
 
+csharp/
+        Experimental C# bindings.
+
 daemon/
         The daemon that runs inside the guest and carries out actions.
 
-df/
-        The virt-df tool.
-
 examples/
         The examples.
 
 fish/
         Guestfish (the command-line program / shell)
 
+fuse/
+        FUSE (userspace filesystem) built on top of libguestfs.
+
+generator/
+        The crucially important generator, used to automatically
+        generate large amounts of boilerplate C code for things like
+        RPC and bindings.
+
 haskell/
         Haskell bindings.
 
+hivex/ [removed in 1.0.85]
+       This used to contain the hivex library for reading and
+       writing Windows Registry binary hive files.  This is now
+       available as a separate upstream project.
+
 images/
         Some guest images to test against.  These are gzipped to save
         space.  You have to unzip them before use.
@@ -72,8 +123,17 @@ m4/
 ocaml/
         OCaml bindings.
 
+php/
+        PHP bindings.
+
 po/
-        Translations.
+        Translations of simple gettext strings.  For translations of
+        longer documents, see po-docs/.
+
+po-docs/
+        The build infrastructure and PO files for translations of
+        manpages and POD files.  Eventually this will be combined
+        with the po/ directory, but that is rather complicated.
 
 perl/
         Perl bindings.
@@ -87,16 +147,15 @@ regressions/
 ruby/
         Ruby bindings.
 
+tools/
+        Command line tools like virt-df, virt-edit and more.
+
 src/
         Source code to the C library.
-        Also contains the crucial generator program.
 
 test-tool/
         Interactive qemu/kernel test tool.
 
-v2v/
-        Xen to KVM (V2V) conversion tool.
-
 Debugging
 ----------------------------------------------------------------------