Document alpm_list files are to be stand alone

Signed-off-by: Allan McRae <allan@archlinux.org>
2013-06-03 14:15:31 +10:00 · 2013-06-03 14:15:31 +10:00 · 37e85c0031
parent ab3d8478c2
commit 37e85c0031
2 changed files with 8 additions and 0 deletions
--- 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"

--- 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