2021-08-23 11:35:07

by Michal Simek

Subject: [PATCH] clk: zynqmp: Fix kernel-doc format

Align structure and function names with definitions.

Issues are reported by kernel-doc script as:
drivers/clk/zynqmp/clk-gate-zynqmp.c:24: warning: expecting prototype for
struct clk_gate. Prototype was for struct zynqmp_clk_gate instead
drivers/clk/zynqmp/clk-gate-zynqmp.c:75: warning: expecting prototype for
zynqmp_clk_gate_is_enable(). Prototype was for zynqmp_clk_gate_is_enabled()
instead

Signed-off-by: Michal Simek <[email protected]>
---

drivers/clk/zynqmp/clk-gate-zynqmp.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/clk/zynqmp/clk-gate-zynqmp.c b/drivers/clk/zynqmp/clk-gate-zynqmp.c
index 695feaa82da5..565ed67a0430 100644
--- a/drivers/clk/zynqmp/clk-gate-zynqmp.c
+++ b/drivers/clk/zynqmp/clk-gate-zynqmp.c
@@ -12,7 +12,7 @@
#include "clk-zynqmp.h"

/**
- * struct clk_gate - gating clock
+ * struct zynqmp_clk_gate - gating clock
* @hw: handle between common and hardware-specific interfaces
* @flags: hardware-specific flags
* @clk_id: Id of clock
@@ -66,7 +66,7 @@ static void zynqmp_clk_gate_disable(struct clk_hw *hw)
}

/**
- * zynqmp_clk_gate_is_enable() - Check clock state
+ * zynqmp_clk_gate_is_enabled() - Check clock state
* @hw: handle between common and hardware-specific interfaces
*
* Return: 1 if enabled, 0 if disabled else error code
--
2.33.0

2021-08-29 06:50:13

by Stephen Boyd

Subject: Re: [PATCH] clk: zynqmp: Fix kernel-doc format

Quoting Michal Simek (2021-08-23 04:33:47)
> Align structure and function names with definitions.
>
> Issues are reported by kernel-doc script as:
> drivers/clk/zynqmp/clk-gate-zynqmp.c:24: warning: expecting prototype for
> struct clk_gate. Prototype was for struct zynqmp_clk_gate instead
> drivers/clk/zynqmp/clk-gate-zynqmp.c:75: warning: expecting prototype for
> zynqmp_clk_gate_is_enable(). Prototype was for zynqmp_clk_gate_is_enabled()
> instead
>
> Signed-off-by: Michal Simek <[email protected]>
> ---

Applied to clk-next