string-list: document iterator behavior on NULL input

[thirdparty/git.git] / string-list.h

diff --git a/string-list.h b/string-list.h
index d5a744e1438600080b9970e3f7cdedbe7f2a3708..c7b0d5d0008efb906ba034c632adb69b53c4f545 100644 (file)
--- a/string-list.h
+++ b/string-list.h
@@ -141,7 +141,12 @@ void string_list_clear_func(struct string_list *list, string_list_clear_func_t c
 int for_each_string_list(struct string_list *list,
                         string_list_each_func_t func, void *cb_data);
 
-/** Iterate over each item, as a macro. */
+/**
+ * Iterate over each item, as a macro.
+ *
+ * Be sure that 'list' is non-NULL. The macro cannot perform NULL
+ * checks due to -Werror=address errors.
+ */
 #define for_each_string_list_item(item,list)            \
        for (item = (list)->items;                      \
             item && item < (list)->items + (list)->nr; \