of: dynamic: add lifecycle docbook info to node creation functions
authorFrank Rowand <frowand.list@gmail.com>
Mon, 13 Feb 2023 18:57:02 +0000 (12:57 -0600)
committerRob Herring <robh@kernel.org>
Mon, 20 Feb 2023 21:37:19 +0000 (15:37 -0600)
commitd9194e009efef9613f48022f3c885191c48120f9
tree12609eee961b9c7845c0d8173271db84422f4829
parentec0b7e24d566a843e3cfba21a6471170fdb0f810
of: dynamic: add lifecycle docbook info to node creation functions

The existing docbook comments for the functions related to creating
a devicetree node do not explain the reference count of a newly
created node, how decrementing the reference count to zero will
free the associated memory, and the caller's responsibility to
call of_node_put() on the node.  Explain what happens when the
reference count is decremented to zero.

Signed-off-by: Frank Rowand <frowand.list@gmail.com>
Link: https://lore.kernel.org/r/20230213185702.395776-8-frowand.list@gmail.com
Signed-off-by: Rob Herring <robh@kernel.org>
drivers/of/dynamic.c
include/linux/of.h