| Message ID | 20210107023304.24442-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Accepted, archived |
| Headers | show |
| Series | linux/clk.h: use correct kernel-doc notation for 2 functions | expand |
Quoting Randy Dunlap (2021-01-06 18:33:04) > Fix kernel-doc notation for 2 functions so that the generated > html is correct. Currently it skips all text between the > ':' and the '-', so "[un]register a clock rate" is missing. > > Fixes: 86bcfa2e87c4 ("clk: add pr_debug & kerneldoc around clk notifiers") > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Mike Turquette <mturquette@linaro.org> > Cc: Russell King <linux@armlinux.org.uk> > Cc: linux-clk@vger.kernel.org > --- Applied to clk-next
--- linux-next-20210105.orig/include/linux/clk.h +++ linux-next-20210105/include/linux/clk.h @@ -92,7 +92,7 @@ struct clk_bulk_data { #ifdef CONFIG_COMMON_CLK /** - * clk_notifier_register: register a clock rate-change notifier callback + * clk_notifier_register - register a clock rate-change notifier callback * @clk: clock whose rate we are interested in * @nb: notifier block with callback function pointer * @@ -103,7 +103,7 @@ struct clk_bulk_data { int clk_notifier_register(struct clk *clk, struct notifier_block *nb); /** - * clk_notifier_unregister: unregister a clock rate-change notifier callback + * clk_notifier_unregister - unregister a clock rate-change notifier callback * @clk: clock whose rate we are no longer interested in * @nb: notifier block which will be unregistered */
Fix kernel-doc notation for 2 functions so that the generated html is correct. Currently it skips all text between the ':' and the '-', so "[un]register a clock rate" is missing. Fixes: 86bcfa2e87c4 ("clk: add pr_debug & kerneldoc around clk notifiers") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Mike Turquette <mturquette@linaro.org> Cc: Russell King <linux@armlinux.org.uk> Cc: linux-clk@vger.kernel.org --- include/linux/clk.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)