diff options
| author |   Anna-Maria Behnsen <anna-maria@linutronix.de> | 2024-01-23 17:46:56 +0100 |
|---|---|---|
| committer |   Thomas Gleixner <tglx@linutronix.de> | 2024-02-19 09:37:59 +0100 |
| commit | ca2768bbf5c48d8c048877dfbceafcebc3f06fa6 (patch) | |
| tree | 4f5b33c61c9a1f4e832519d7cd5e184ae3374c18 /include/linux/hrtimer.h | |
| parent | hrtimers: Move hrtimer base related definitions into hrtimer_defs.h (diff) | |
| download | wireguard-linux-ca2768bbf5c48d8c048877dfbceafcebc3f06fa6.tar.xz wireguard-linux-ca2768bbf5c48d8c048877dfbceafcebc3f06fa6.zip | |
hrtimers: Update formatting of documentation
Documentation of functions lacks the annotations which are used by
kernel-doc and *.rst to make appearance in rendered documents more
user-friendly.
Use those annotations to improve user-friendliness. While at it prevent
duplication of comments and use a reference instead.
Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20240123164702.55612-3-anna-maria@linutronix.de
Diffstat (limited to 'include/linux/hrtimer.h')
| -rw-r--r-- | include/linux/hrtimer.h | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index 792a0ac75378..aa1e65ccb615 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h @@ -342,20 +342,12 @@ extern u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval); /** - * hrtimer_forward_now - forward the timer expiry so it expires after now + * hrtimer_forward_now() - forward the timer expiry so it expires after now * @timer: hrtimer to forward * @interval: the interval to forward * - * Forward the timer expiry so it will expire after the current time - * of the hrtimer clock base. Returns the number of overruns. - * - * Can be safely called from the callback function of @timer. If - * called from other contexts @timer must neither be enqueued nor - * running the callback and the caller needs to take care of - * serialization. - * - * Note: This only updates the timer expiry value and does not requeue - * the timer. + * It is a variant of hrtimer_forward(). The timer will expire after the current + * time of the hrtimer clock base. See hrtimer_forward() for details. */ static inline u64 hrtimer_forward_now(struct hrtimer *timer, ktime_t interval) |