summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING34
1 files changed, 32 insertions, 2 deletions
diff --git a/HACKING b/HACKING
index 9d8681cc..ea8936db 100644
--- a/HACKING
+++ b/HACKING
@@ -1,8 +1,8 @@
Contributing to pacman
======================
-Please read 'submitting-patches' and 'translation-help' in the same directory as
-this file.
+Please read 'submitting-patches' and 'translation-help' in the same directory
+as this file.
Coding style
------------
@@ -62,4 +62,34 @@ Coding style
NOT
sizeof(*mylist);
+Other Concerns
+--------------
+
+Currently our #include usage is in messy shape, but this is no reason to
+continue down this messy path. When adding an include to a file, follow this
+general pattern, including blank lines:
+
+#include "config.h"
+
+#include <standardheader.h>
+#include <another.h>
+#include <...>
+
+Follow this with some more headers, depending on whether the file is in libalpm
+or pacman proper. For libalpm:
+
+/* libalpm */
+#include "yourfile.h"
+#include "alpm_list.h"
+#include "anythingelse.h"
+
+For pacman:
+
+#include <alpm.h>
+#include <alpm_list.h>
+
+/* pacman */
+#include "yourfile.h"
+#include "anythingelse.h"
+
vim: set ts=2 sw=2 et: