linux-rtc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] rtc: ac100: remove misuses of kernel-doc
@ 2024-01-14 23:13 Randy Dunlap
  2024-01-15 21:28 ` Alexandre Belloni
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2024-01-14 23:13 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Chen-Yu Tsai, Alexandre Belloni, linux-rtc

Prevent kernel-doc warnings by changing "/**" to common comment
format "/*" in non-kernel-doc comments:

drivers/rtc/rtc-ac100.c:103: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Clock controls for 3 clock output pins
drivers/rtc/rtc-ac100.c:382: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * RTC related bits

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Chen-Yu Tsai <wens@csie.org>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: linux-rtc@vger.kernel.org
---
 drivers/rtc/rtc-ac100.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/drivers/rtc/rtc-ac100.c b/drivers/rtc/rtc-ac100.c
--- a/drivers/rtc/rtc-ac100.c
+++ b/drivers/rtc/rtc-ac100.c
@@ -99,7 +99,7 @@ struct ac100_rtc_dev {
 	struct clk_hw_onecell_data *clk_data;
 };
 
-/**
+/*
  * Clock controls for 3 clock output pins
  */
 
@@ -378,7 +378,7 @@ static void ac100_rtc_unregister_clks(st
 	clk_unregister_fixed_rate(chip->rtc_32k_clk->clk);
 }
 
-/**
+/*
  * RTC related bits
  */
 static int ac100_rtc_get_time(struct device *dev, struct rtc_time *rtc_tm)

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] rtc: ac100: remove misuses of kernel-doc
  2024-01-14 23:13 [PATCH] rtc: ac100: remove misuses of kernel-doc Randy Dunlap
@ 2024-01-15 21:28 ` Alexandre Belloni
  0 siblings, 0 replies; 2+ messages in thread
From: Alexandre Belloni @ 2024-01-15 21:28 UTC (permalink / raw)
  To: linux-kernel, Randy Dunlap; +Cc: Chen-Yu Tsai, linux-rtc


On Sun, 14 Jan 2024 15:13:20 -0800, Randy Dunlap wrote:
> Prevent kernel-doc warnings by changing "/**" to common comment
> format "/*" in non-kernel-doc comments:
> 
> drivers/rtc/rtc-ac100.c:103: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Clock controls for 3 clock output pins
> drivers/rtc/rtc-ac100.c:382: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * RTC related bits
> 
> [...]

Applied, thanks!

[1/1] rtc: ac100: remove misuses of kernel-doc
      commit: eea7615b684fc98cd0403beaaa2194e6f029c812

Best regards,

-- 
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-01-15 21:28 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-01-14 23:13 [PATCH] rtc: ac100: remove misuses of kernel-doc Randy Dunlap
2024-01-15 21:28 ` Alexandre Belloni

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).