X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=src%2Flist.h;h=b0e7a845240124663f77812e840b47e1570c3f0b;hp=0437bd9297ebe86c54e16767a442091db497b76f;hb=d4410d0cce40929db9a0ce7042ef962f1867234d;hpb=70a1a5594af5d4e6a364186b42ba4e34c676009b

diff --git a/src/list.h b/src/list.h
index 0437bd92..b0e7a845 100644
--- a/src/list.h
+++ b/src/list.h
@@ -79,6 +79,12 @@ extern void list_delete_list(list_t *);
 extern void list_foreach(list_t *, list_action_t);
 extern void list_foreach_node(list_t *, list_action_node_t);
 
+/*
+   Iterates over a list.
+
+   CAUTION: while this construct supports deleting the current item,
+   it does *not* support deleting *other* nodes while iterating on the list.
+ */
 #define list_each(type, item, list) (type *item = (type *)1; item; item = NULL) for(list_node_t *node = (list)->head, *next; item = node ? node->data : NULL, next = node ? node->next : NULL, node; node = next)
 
 #endif /* __TINC_LIST_H__ */