clocksource: arm_global_timer: fix non-kernel-doc comment
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 15 Jan 2024 05:36:41 +0000 (21:36 -0800)
committerDaniel Lezcano <daniel.lezcano@linaro.org>
Wed, 21 Feb 2024 08:56:06 +0000 (09:56 +0100)
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>
Signed-off-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/20240115053641.29129-1-rdunlap@infradead.org
drivers/clocksource/arm_global_timer.c

index 8dd1e46b7176dca2db54498ca01207e44863ca57..d749dee1d41ddc128f8ae9a789f8bec62ef9e459 100644 (file)
@@ -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.