From: Rusty Russell <rusty@rustcorp.com.au>
Date: Fri, 19 Jun 2020 01:45:21 +0000 (+0930)
Subject: tal: document tal_steal(ctx, NULL) as OK.
X-Git-Url: http://git.ozlabs.org/?p=ccan;a=commitdiff_plain;h=fc339122d69a85e5238d8bd7069d24ed4be4aed4

tal: document tal_steal(ctx, NULL) as OK.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
---

diff --git a/ccan/tal/tal.h b/ccan/tal/tal.h
index 8b7ffca5..20cd89c5 100644
--- a/ccan/tal/tal.h
+++ b/ccan/tal/tal.h
@@ -131,10 +131,11 @@ void *tal_free(const tal_t *p);
 /**
  * tal_steal - change the parent of a tal-allocated pointer.
  * @ctx: The new parent.
- * @ptr: The tal allocated object to move.
+ * @ptr: The tal allocated object to move, or NULL.
  *
  * This may need to perform an allocation, in which case it may fail; thus
- * it can return NULL, otherwise returns @ptr.
+ * it can return NULL, otherwise returns @ptr.  If @ptr is NULL, this function does
+ * nothing.
  */
 #if HAVE_STATEMENT_EXPR
 /* Weird macro avoids gcc's 'warning: value computed is not used'. */