[pacman-dev] [PATCH] Document alpm_list files are to be stand alone

[Allan McRae]

Signed-off-by: Allan McRae <allan at archlinux.org>
---
 lib/libalpm/alpm_list.c | 4 ++++
 lib/libalpm/alpm_list.h | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/lib/libalpm/alpm_list.c b/lib/libalpm/alpm_list.c
index bcd42b8..59f99f9 100644
--- a/lib/libalpm/alpm_list.c
+++ b/lib/libalpm/alpm_list.c
@@ -21,6 +21,10 @@
 #include <stdlib.h>
 #include <string.h>
 
+/* Note: alpm_list.{c,h} are intended to be standalone files. Do not include
+ * any other libalpm headers.
+ */
+
 /* libalpm */
 #include "alpm_list.h"
 
diff --git a/lib/libalpm/alpm_list.h b/lib/libalpm/alpm_list.h
index 72c7378..3f3566b 100644
--- a/lib/libalpm/alpm_list.h
+++ b/lib/libalpm/alpm_list.h
@@ -22,6 +22,10 @@
 
 #include <stdlib.h> /* size_t */
 
+/* Note: alpm_list.{c,h} are intended to be standalone files. Do not include
+ * any other libalpm headers.
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
-- 
1.8.3