[GNUnet-SVN] r27597 - gnunet/src/include

[gnunet]

Author: dold
Date: 2013-06-25 22:51:44 +0200 (Tue, 25 Jun 2013)
New Revision: 27597

Modified:
   gnunet/src/include/gnunet_container_lib.h
Log:
documented corner case of dll remove


Modified: gnunet/src/include/gnunet_container_lib.h
===================================================================
--- gnunet/src/include/gnunet_container_lib.h   2013-06-25 16:52:52 UTC (rev 
27596)
+++ gnunet/src/include/gnunet_container_lib.h   2013-06-25 20:51:44 UTC (rev 
27597)
@@ -999,10 +999,14 @@
 
 
 /**
- * Remove an element from a DLL. Assumes
- * that head, tail and element are structs
- * with prev and next fields.
+ * Remove an element from a DLL. Assumes that head, tail and
+ * element point to structs with prev and next fields.
  *
+ * Using the head or tail pointer as the element
+ * argument does NOT work with this macro.
+ * Make sure to store head/tail in another pointer
+ * and use it to remove the head or tail of the list.
+ *
  * @param head pointer to the head of the DLL
  * @param tail pointer to the tail of the DLL
  * @param element element to remove