tal: use notifier infrastructure for destructors.

[ccan] / ccan / tal / tal.h

diff --git a/ccan/tal/tal.h b/ccan/tal/tal.h
index 8ee27c36ed1dce69e45d40187f976b23292712a2..4e862cd631177297cdc47497d4466a6f15923dc6 100644 (file)
--- a/ccan/tal/tal.h
+++ b/ccan/tal/tal.h
@@ -127,6 +127,9 @@ void *tal_free(const tal_t *p);
  * @ptr: The tal allocated object.
  * @function: the function to call before it's freed.
  *
+ * This is a more convenient form of tal_add_notifier(@ptr,
+ * TAL_NOTIFY_FREE, ...), in that the function prototype takes only @ptr.
+ *
  * Note that this can only fail if your allocfn fails and your errorfn returns.
  */
 #define tal_add_destructor(ptr, function)                                    \
@@ -187,9 +190,10 @@ enum tal_notify_type {
  * not called when this context is tal_free()d: TAL_NOTIFY_FREE is
  * considered sufficient for that case.
  *
- * TAL_NOTIFY_ADD_NOTIFIER/TAL_NOTIFIER_DEL_NOTIFIER are called when
- * a notifier is added or removed (not for this notifier): @info is the
- * callback.
+ * TAL_NOTIFY_ADD_NOTIFIER/TAL_NOTIFIER_DEL_NOTIFIER are called when a
+ * notifier is added or removed (not for this notifier): @info is the
+ * callback.  This is also called for tal_add_destructor and
+ * tal_del_destructor.
  */
 #define tal_add_notifier(ptr, types, callback)                         \
        tal_add_notifier_((ptr), (types),                               \