[tip: timers/core] clockevents: Repair kernel-doc for clockevent_delta2ns()

From: tip-bot2 for Lukas Bulwahn
Date: Thu Dec 01 2022 - 07:44:26 EST


The following commit has been merged into the timers/core branch of tip:

Commit-ID: ebe11732838f39bd10bddafd4dfe2f97010fde62
Gitweb: https://git.kernel.org/tip/ebe11732838f39bd10bddafd4dfe2f97010fde62
Author: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx>
AuthorDate: Wed, 02 Nov 2022 10:10:48 +01:00
Committer: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Thu, 01 Dec 2022 13:35:41 +01:00

clockevents: Repair kernel-doc for clockevent_delta2ns()

Since the introduction of clockevents, i.e., commit d316c57ff6bf
("clockevents: add core functionality"), there has been a mismatch between
the function and the kernel-doc comment for clockevent_delta2ns().

Hence, ./scripts/kernel-doc -none kernel/time/clockevents.c warns about it.

Adjust the kernel-doc comment for clockevent_delta2ns() for make W=1
happiness.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Link: https://lore.kernel.org/r/20221102091048.15068-1-lukas.bulwahn@xxxxxxxxx

---
kernel/time/clockevents.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/time/clockevents.c b/kernel/time/clockevents.c
index 5d85014..960143b 100644
--- a/kernel/time/clockevents.c
+++ b/kernel/time/clockevents.c
@@ -76,7 +76,7 @@ static u64 cev_delta2ns(unsigned long latch, struct clock_event_device *evt,
}

/**
- * clockevents_delta2ns - Convert a latch value (device ticks) to nanoseconds
+ * clockevent_delta2ns - Convert a latch value (device ticks) to nanoseconds
* @latch: value to convert
* @evt: pointer to clock event device descriptor
*