| Message ID | 20240115053641.29129-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | clocksource: arm_global_timer: fix non-kernel-doc comment | expand |
On 15/01/2024 06:36, Randy Dunlap wrote: > Use a common C comment "/*" instead of a kernel-doc marker "/**" > to prevent kernel-doc warnings: > > arm_global_timer.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * To ensure that updates to comparator value register do not set the > arm_global_timer.c:92: warning: missing initial short description on line: > * To ensure that updates to comparator value register do not set the > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Patrice Chotard <patrice.chotard@foss.st.com> > Cc: linux-arm-kernel@lists.infradead.org > Cc: Daniel Lezcano <daniel.lezcano@linaro.org> > Cc: Thomas Gleixner <tglx@linutronix.de> > --- Applied, thanks
diff -- a/drivers/clocksource/arm_global_timer.c b/drivers/clocksource/arm_global_timer.c --- a/drivers/clocksource/arm_global_timer.c +++ b/drivers/clocksource/arm_global_timer.c @@ -88,7 +88,7 @@ static u64 gt_counter_read(void) return _gt_counter_read(); } -/** +/* * To ensure that updates to comparator value register do not set the * Interrupt Status Register proceed as follows: * 1. Clear the Comp Enable bit in the Timer Control Register.
Use a common C comment "/*" instead of a kernel-doc marker "/**" to prevent kernel-doc warnings: arm_global_timer.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * To ensure that updates to comparator value register do not set the arm_global_timer.c:92: warning: missing initial short description on line: * To ensure that updates to comparator value register do not set the Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Patrice Chotard <patrice.chotard@foss.st.com> Cc: linux-arm-kernel@lists.infradead.org Cc: Daniel Lezcano <daniel.lezcano@linaro.org> Cc: Thomas Gleixner <tglx@linutronix.de> --- drivers/clocksource/arm_global_timer.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)