X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Flist%2Flist.h;h=c4956a0d03814145a4d42e3b11a8bce93a611484;hp=d47e13253b56596d83fac64cf7fef1b907b9dc40;hb=22ffb884ca6a5f16517e49e051d8fb5a22e5049d;hpb=9ca74a8e616261a3afebcc52472a25f2d551e2b6

diff --git a/ccan/list/list.h b/ccan/list/list.h
index d47e1325..c4956a0d 100644
--- a/ccan/list/list.h
+++ b/ccan/list/list.h
@@ -39,7 +39,7 @@ struct list_head
 };
 
 /**
- * list_check - check a list for consistency
+ * list_check - check head of a list for consistency
  * @h: the list_head
  * @abortstr: the location to print on aborting, or NULL.
  *
@@ -51,12 +51,14 @@ struct list_head
  * Returns the list head if the list is consistent, NULL if not (it
  * can never return NULL if @abortstr is set).
  *
+ * See also: list_check_node()
+ *
  * Example:
  *	static void dump_parent(struct parent *p)
  *	{
  *		struct child *c;
  *
- *		printf("%s (%u children):\n", p->name, parent->num_children);
+ *		printf("%s (%u children):\n", p->name, p->num_children);
  *		list_check(&p->children, "bad child list");
  *		list_for_each(&p->children, c, list)
  *			printf(" -> %s\n", c->name);
@@ -64,17 +66,52 @@ struct list_head
  */
 struct list_head *list_check(const struct list_head *h, const char *abortstr);
 
+/**
+ * list_check_node - check node of a list for consistency
+ * @n: the list_node
+ * @abortstr: the location to print on aborting, or NULL.
+ *
+ * Check consistency of the list node is in (it must be in one).
+ *
+ * See also: list_check()
+ *
+ * Example:
+ *	static void dump_child(const struct child *c)
+ *	{
+ *		list_check_node(&c->list, "bad child list");
+ *		printf("%s\n", c->name);
+ *	}
+ */
+struct list_node *list_check_node(const struct list_node *n,
+				  const char *abortstr);
+
 #ifdef CCAN_LIST_DEBUG
 #define debug_list(h) list_check((h), __func__)
 #else
 #define debug_list(h) (h)
 #endif
 
+/**
+ * LIST_HEAD - define and initalize an empty list_head
+ * @name: the name of the list.
+ *
+ * The LIST_HEAD macro defines a list_head and initializes it to an empty
+ * list.  It can be prepended by "static" to define a static list_head.
+ *
+ * Example:
+ *	static LIST_HEAD(my_global_list);
+ */
+#define LIST_HEAD(name) \
+	struct list_head name = { { &name.n, &name.n } }
+
 /**
  * list_head_init - initialize a list_head
  * @h: the list_head to set to the empty list
  *
  * Example:
+ *	...
+ *	struct parent *parent = malloc(sizeof(*parent));
+ *
  *	list_head_init(&parent->children);
  *	parent->num_children = 0;
  */
@@ -83,23 +120,6 @@ static inline void list_head_init(struct list_head *h)
 	h->n.next = h->n.prev = &h->n;
 }
 
-/**
- * LIST_HEAD - define and initalized empty list_head
- * @name: the name of the list.
- *
- * The LIST_HEAD macro defines a list_head and initializes it to an empty
- * list.  It can be prepended by "static" to define a static list_head.
- *
- * Example:
- *	// Header:
- *	extern struct list_head my_list;
- *
- *	// C file:
- *	LIST_HEAD(my_list);
- */
-#define LIST_HEAD(name) \
-	struct list_head name = { { &name.n, &name.n } }
-
 /**
  * list_add - add an entry at the start of a linked list.
  * @h: the list_head to add the node to
@@ -107,6 +127,9 @@ static inline void list_head_init(struct list_head *h)
  *
  * The list_node does not need to be initialized; it will be overwritten.
  * Example:
+ *	struct child *child = malloc(sizeof(*child));
+ *
+ *	child->name = "marvin";
  *	list_add(&parent->children, &child->list);
  *	parent->num_children++;
  */
@@ -179,9 +202,11 @@ static inline bool list_empty(const struct list_head *h)
  * @member: the list_node member of the type
  *
  * Example:
- *	struct child *c;
  *	// First list entry is children.next; convert back to child.
- *	c = list_entry(parent->children.next, struct child, list);
+ *	child = list_entry(parent->children.n.next, struct child, list);
+ *
+ * See Also:
+ *	list_top(), list_for_each()
  */
 #define list_entry(n, type, member) container_of(n, type, member)
 
@@ -225,9 +250,8 @@ static inline bool list_empty(const struct list_head *h)
  * a for loop, so you can break and continue as normal.
  *
  * Example:
- *	struct child *c;
- *	list_for_each(&parent->children, c, list)
- *		printf("Name: %s\n", c->name);
+ *	list_for_each(&parent->children, child, list)
+ *		printf("Name: %s\n", child->name);
  */
 #define list_for_each(h, i, member)					\
 	for (i = container_of_var(debug_list(h)->n.next, i, member);	\
@@ -246,9 +270,9 @@ static inline bool list_empty(const struct list_head *h)
  * @nxt is used to hold the next element, so you can delete @i from the list.
  *
  * Example:
- *	struct child *c, *n;
- *	list_for_each_safe(&parent->children, c, n, list) {
- *		list_del(&c->list);
+ *	struct child *next;
+ *	list_for_each_safe(&parent->children, child, next, list) {
+ *		list_del(&child->list);
  *		parent->num_children--;
  *	}
  */