summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Rowand <frank.rowand@sony.com>2019-01-24 15:22:14 -0800
committerRob Herring <robh@kernel.org>2019-02-13 12:13:03 -0600
commit89716dc353bdf1ab34c3a41d3f157ce28b4fbe7d (patch)
treed1191eebc415e5f7477908c967181eb9bb81912f
parentfd25ffdfd0b520f25d5c532e962dfc20d58cf4f5 (diff)
downloadlinux-89716dc353bdf1ab34c3a41d3f157ce28b4fbe7d.tar.bz2
of: unittest: add caution to function header comment
Name of function attach_node_and_children() is misleading because if the node already exists in the livetree then only the node's properties are attached. This works for the existing test data, but add comment warning of this misleading name. Signed-off-by: Frank Rowand <frank.rowand@sony.com> Signed-off-by: Rob Herring <robh@kernel.org>
-rw-r--r--drivers/of/unittest.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/drivers/of/unittest.c b/drivers/of/unittest.c
index 3249fe259d30..872956500c27 100644
--- a/drivers/of/unittest.c
+++ b/drivers/of/unittest.c
@@ -1127,7 +1127,11 @@ static void update_node_properties(struct device_node *np,
/**
* attach_node_and_children - attaches nodes
- * and its children to live tree
+ * and its children to live tree.
+ * CAUTION: misleading function name - if node @np already exists in
+ * the live tree then children of @np are *not* attached to the live
+ * tree. This works for the current test devicetree nodes because such
+ * nodes do not have child nodes.
*
* @np: Node to attach to live tree
*/