X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=9cc16c3e67528888fc0e2e8592b7c4aedf2e2796;hp=cb339bd148144cc05be60cfc2c4710e1c6337861;hb=5f9be62e68b120f51c948404e7f0cf3430962c68;hpb=1fc38df2dfe7e991e27d4c2fdd50fbd41ee9cf70

diff --git a/HACKING b/HACKING
index cb339bd..9cc16c3 100644
--- a/HACKING
+++ b/HACKING
@@ -24,6 +24,13 @@ 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
@@ -35,16 +42,24 @@ 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 indent-tabs-mode nil) ; indent using spaces, not TABs
     (setq c-indent-level 2)
     (setq c-basic-offset 2))
   (add-hook 'c-mode-hook
-            '(lambda () (if (string-match "/libguestfs" (buffer-file-name))
+            '(lambda () (if (string-match "/libguestfs\\>" (buffer-file-name))
                             (libguestfs-c-mode))))
 
 Directories
@@ -53,9 +68,6 @@ Directories
 appliance/
         The qemu appliance, build scripts and so on.
 
-cat/
-        The virt-cat tool.
-
 capitests/
         Automated tests of the C API.
 
@@ -65,18 +77,22 @@ contrib/
 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.
+
 haskell/
         Haskell bindings.
 
+hivex/
+        Hive extraction library, for reading Windows Registry files.
+        See hivex/README for more details.
+
 images/
         Some guest images to test against.  These are gzipped to save
         space.  You have to unzip them before use.
@@ -110,6 +126,12 @@ regressions/
 ruby/
         Ruby bindings.
 
+tools/
+        Command line tools like virt-cat, virt-df, virt-edit and more.
+        In versions <= 1.0.73 these were all in separate directories
+        like cat/, df/, edit/, but since then we moved them all into
+        one directory to simplify builds.
+
 src/
         Source code to the C library.
         Also contains the crucial generator program.
@@ -117,9 +139,6 @@ src/
 test-tool/
         Interactive qemu/kernel test tool.
 
-v2v/
-        Xen to KVM (V2V) conversion tool.
-
 Debugging
 ----------------------------------------------------------------------