tal: document tal_steal(ctx, NULL) as OK.
authorRusty Russell <rusty@rustcorp.com.au>
Fri, 19 Jun 2020 01:45:21 +0000 (11:15 +0930)
committerRusty Russell <rusty@rustcorp.com.au>
Fri, 19 Jun 2020 01:45:21 +0000 (11:15 +0930)
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ccan/tal/tal.h

index 8b7ffca5ea8125ef8ba36a623d989e8aad6fff33..20cd89c5ee956ef0bc2e9dc63d27810b5ca0bf0d 100644 (file)
@@ -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'. */