diff mbox series

[07/21] dm: core: Update comment for ofnode_get_chosen_node()

Message ID 20200127084920.7.If25281d45a0cd34637ee21792c9926a836078fcc@changeid
State Accepted
Commit 74d594a20e035a2dfce232093774c50d986cb9ff
Delegated to: Simon Glass
Headers show
Series dm: Various enhancements to prepare for ACPI | expand

Commit Message

Simon Glass Jan. 27, 2020, 3:49 p.m. UTC
The current comment is a big vague and misleading. Rewrite it to state
precisely what the function does.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/dm/ofnode.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Simon Glass Feb. 5, 2020, 5:56 p.m. UTC | #1
The current comment is a big vague and misleading. Rewrite it to state
precisely what the function does.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/dm/ofnode.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Applied to u-boot-dm, thanks!
diff mbox series

Patch

diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h
index 4282169706..62ba0c13ea 100644
--- a/include/dm/ofnode.h
+++ b/include/dm/ofnode.h
@@ -520,11 +520,14 @@  ofnode ofnode_path(const char *path);
 const char *ofnode_get_chosen_prop(const char *propname);
 
 /**
- * ofnode_get_chosen_node() - get the chosen node
+ * ofnode_get_chosen_node() - get a referenced node from the chosen node
  *
- * @return the chosen node if present, else ofnode_null()
+ * This looks up a named property in the chosen node and uses that as a path to
+ * look up a code.
+ *
+ * @return the referenced node if present, else ofnode_null()
  */
-ofnode ofnode_get_chosen_node(const char *name);
+ofnode ofnode_get_chosen_node(const char *propname);
 
 struct display_timing;
 /**