| Message ID | 20190312110016.29174-3-m.tretter@pengutronix.de (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | clk: zynqmp: fix CLK_FRAC and various cleanups | expand |
On 12. 03. 19 12:00, Michael Tretter wrote: > The kernel-doc refers to __zynqmp_clock_get_topology(), while it actually > documents __zynqmp_clock_get_parents(). Fix the documentation to refer > to the correct function name. > > Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> > --- > I think most of the function documentation in this file is pretty > useless and sometimes misleading. Maybe we should drop the documentation > entirely, because all functions are static anyway? Interesting is that kernel-doc is not able to find this issue. drivers/clk/zynqmp/clkc.c:336: info: Scanning doc for zynqmp_pm_clock_get_attributes drivers/clk/zynqmp/clkc.c:360: info: Scanning doc for __zynqmp_clock_get_topology drivers/clk/zynqmp/clkc.c:388: info: Scanning doc for zynqmp_clock_get_topology drivers/clk/zynqmp/clkc.c:418: info: Scanning doc for __zynqmp_clock_get_topology drivers/clk/zynqmp/clkc.c:453: info: Scanning doc for zynqmp_clock_get_parents drivers/clk/zynqmp/clkc.c:485: info: Scanning doc for zynqmp_get_parent_list I think that doc is good because it helps with understanding of code. If there is something misleading that it should be rather fix then remove. M
diff --git a/drivers/clk/zynqmp/clkc.c b/drivers/clk/zynqmp/clkc.c index b0908ec62f73..d3d4ce305e71 100644 --- a/drivers/clk/zynqmp/clkc.c +++ b/drivers/clk/zynqmp/clkc.c @@ -408,7 +408,7 @@ static int zynqmp_clock_get_topology(u32 clk_id, } /** - * __zynqmp_clock_get_topology() - Get parents info of clock from firmware + * __zynqmp_clock_get_parents() - Get parents info of clock from firmware * response data * @parents: Clock parents * @data: Clock parents data received from firmware
The kernel-doc refers to __zynqmp_clock_get_topology(), while it actually documents __zynqmp_clock_get_parents(). Fix the documentation to refer to the correct function name. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> --- I think most of the function documentation in this file is pretty useless and sometimes misleading. Maybe we should drop the documentation entirely, because all functions are static anyway? --- drivers/clk/zynqmp/clkc.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)