[tip: timers/core] timekeeping: Add missing parameter documentation for update_fast_timekeeper()
From: tip-bot2 for Alex Shi
Date: Sun Nov 15 2020 - 17:51:39 EST
The following commit has been merged into the timers/core branch of tip:
Commit-ID: e025b03113d27139ce2b28b82599018e4d8fa5f6
Gitweb: https://git.kernel.org/tip/e025b03113d27139ce2b28b82599018e4d8fa5f6
Author: Alex Shi <alex.shi@xxxxxxxxxxxxxxxxx>
AuthorDate: Fri, 13 Nov 2020 15:24:31 +08:00
Committer: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
CommitterDate: Sun, 15 Nov 2020 23:47:24 +01:00
timekeeping: Add missing parameter documentation for update_fast_timekeeper()
Address the following warning:
kernel/time/timekeeping.c:415: warning: Function parameter or member
'tkf' not described in 'update_fast_timekeeper'
[ tglx: Remove the bogus ktime_get_mono_fast_ns() part ]
Signed-off-by: Alex Shi <alex.shi@xxxxxxxxxxxxxxxxx>
Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
Link: https://lore.kernel.org/r/1605252275-63652-2-git-send-email-alex.shi@xxxxxxxxxxxxxxxxx
---
kernel/time/timekeeping.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
index 570fc50..a823703 100644
--- a/kernel/time/timekeeping.c
+++ b/kernel/time/timekeeping.c
@@ -407,6 +407,7 @@ static inline u64 timekeeping_cycles_to_ns(const struct tk_read_base *tkr, u64 c
/**
* update_fast_timekeeper - Update the fast and NMI safe monotonic timekeeper.
* @tkr: Timekeeping readout base from which we take the update
+ * @tkf: Pointer to NMI safe timekeeper
*
* We want to use this from any context including NMI and tracing /
* instrumenting the timekeeping code itself.