[PATCH] clk: <linux/clk.h>: correct clk_get_parent() documentation

[Randy Dunlap]

Make the kernel-doc return value agree with both the stub implementation
in <linux/clk.h> and the non-stub function in drivers/clk/clk.c.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Russell King <linux@xxxxxxxxxxxxxxx>
Cc: linux-clk@xxxxxxxxxxxxxxx
---
There are several drivers that call clk_get_parent() and use its
return value as though it returns an ERR_PTR(). I am working on a
patch series to fix those.

 include/linux/clk.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20210426.orig/include/linux/clk.h
+++ linux-next-20210426/include/linux/clk.h
@@ -744,8 +744,8 @@ int clk_set_parent(struct clk *clk, stru
  * clk_get_parent - get the parent clock source for this clock
  * @clk: clock source
  *
- * Returns struct clk corresponding to parent clock source, or
- * valid IS_ERR() condition containing errno.
+ * Return: &struct clk corresponding to parent clock source, or
+ * %NULL if clk is %NULL.
  */
 struct clk *clk_get_parent(struct clk *clk);