clk: Fix comment to clk_get_parent
diff mbox

Message ID 20170514202825.20389-1-alexander.sverdlin@gmail.com
State Rejected
Headers show

Commit Message

Alexander Sverdlin May 14, 2017, 8:28 p.m. UTC
There is no single implementation of clk_get_parent, which returns ERR_PTR().
Therefore, fix the comment in common header linux/clk.h, which claims otherwise.

Signed-off-by: Alexander Sverdlin <alexander.sverdlin@gmail.com>
---
 include/linux/clk.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Russell King - ARM Linux admin May 14, 2017, 9:43 p.m. UTC | #1
On Sun, May 14, 2017 at 10:28:25PM +0200, Alexander Sverdlin wrote:
> There is no single implementation of clk_get_parent, which returns ERR_PTR().
> Therefore, fix the comment in common header linux/clk.h, which claims otherwise.

clk.h is the API definition, not the documentation of the implementation(s).
Please leave it as-is.

Patch
diff mbox

diff --git a/include/linux/clk.h b/include/linux/clk.h
index 024cd07870d0..93b1857085fa 100644
--- a/include/linux/clk.h
+++ b/include/linux/clk.h
@@ -417,7 +417,7 @@  int clk_set_parent(struct clk *clk, struct clk *parent);
  * @clk: clock source
  *
  * Returns struct clk corresponding to parent clock source, or
- * valid IS_ERR() condition containing errno.
+ * NULL on error.
  */
 struct clk *clk_get_parent(struct clk *clk);