maint: use spaces, not TABs for indentation

[libguestfs.git] / HACKING

diff --git a/HACKING b/HACKING
index 815ee16..bdb8287 100644 (file)
--- 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,17 +42,25 @@ 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))
-                           (libguestfs-c-mode))))
+            '(lambda () (if (string-match "/libguestfs\\>" (buffer-file-name))
+                            (libguestfs-c-mode))))
 
 Directories
 ----------------------------------------------------------------------
@@ -68,6 +83,9 @@ daemon/
 df/
         The virt-df tool.
 
+edit/
+        The virt-edit tool.
+
 examples/
         The examples.
 
@@ -107,6 +125,9 @@ python/
 regressions/
         Regression tests.
 
+rescue/
+        The virt-rescue tool.
+
 ruby/
         Ruby bindings.
 
@@ -117,9 +138,6 @@ src/
 test-tool/
         Interactive qemu/kernel test tool.
 
-v2v/
-        Xen to KVM (V2V) conversion tool.
-
 Debugging
 ----------------------------------------------------------------------