X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=HACKING;h=815ee16e8608a1b481bceaaed32ccf070671a217;hp=c6a302278970d20e9370d8b7d6de4356ebc7c2a6;hb=4c2c2793bad56ce05caf6244e10fd5bcd7023383;hpb=2f1a50d81671810256dce0852e6b1e0810ac44af

diff --git a/HACKING b/HACKING
index c6a3022..815ee16 100644
--- a/HACKING
+++ b/HACKING
@@ -24,6 +24,29 @@ Please make sure that the code compiles without warnings.
 
 Please test any changes.
 
+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:
+
+  ;;; 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))))
+
 Directories
 ----------------------------------------------------------------------