Fix the kernel-doc markup and remove the following warning:
kernel/time/timekeeping.c:415: warning: Function parameter or member
'tkf' not described in 'update_fast_timekeeper'
kernel/time/timekeeping.c:464: warning: Function parameter or member
'tkf' not described in '__ktime_get_fast_ns'
Signed-off-by: Alex Shi <[email protected]>
Cc: John Stultz <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: Stephen Boyd <[email protected]>
Cc: [email protected]
---
kernel/time/timekeeping.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
index daa0ff017819..d0f7cd1b8823 100644
--- a/kernel/time/timekeeping.c
+++ b/kernel/time/timekeeping.c
@@ -399,6 +399,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: NMI safe timekeeper
*
* We want to use this from any context including NMI and tracing /
* instrumenting the timekeeping code itself.
@@ -430,6 +431,7 @@ static void update_fast_timekeeper(const struct tk_read_base *tkr,
/**
* ktime_get_mono_fast_ns - Fast NMI safe access to clock monotonic
+ * @tkf: NMI safe timekeeper
*
* This timestamp is not guaranteed to be monotonic across an update.
* The timestamp is calculated by:
--
2.29.GIT
On Fri, Nov 13 2020 at 15:24, Alex Shi wrote:
> Fix the kernel-doc markup and remove the following warning:
> kernel/time/timekeeping.c:415: warning: Function parameter or member
> 'tkf' not described in 'update_fast_timekeeper'
> kernel/time/timekeeping.c:464: warning: Function parameter or member
> 'tkf' not described in '__ktime_get_fast_ns'
>
> diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
> index daa0ff017819..d0f7cd1b8823 100644
> --- a/kernel/time/timekeeping.c
> +++ b/kernel/time/timekeeping.c
> @@ -399,6 +399,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: NMI safe timekeeper
> *
> * We want to use this from any context including NMI and tracing /
> * instrumenting the timekeeping code itself.
> @@ -430,6 +431,7 @@ static void update_fast_timekeeper(const struct tk_read_base *tkr,
>
> /**
> * ktime_get_mono_fast_ns - Fast NMI safe access to clock monotonic
> + * @tkf: NMI safe timekeeper
> *
> * This timestamp is not guaranteed to be monotonic across an update.
> * The timestamp is calculated by:
That's wrong. The documentation is for ktime_get_mono_fast_ns() which
does not have an argument, but due to an oversight the documentation is
now above __ktime_get_mono_fast_ns() which takes an argument.
I'm fixing it up.
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 <[email protected]>
AuthorDate: Fri, 13 Nov 2020 15:24:31 +08:00
Committer: Thomas Gleixner <[email protected]>
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 <[email protected]>
Signed-off-by: Thomas Gleixner <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
---
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.