mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "tip-bot2 for Anna-Maria Behnsen" <tip-bot2@linutronix.de>
To: linux-tip-commits@vger.kernel.org
Cc: "Anna-Maria Behnsen" <anna-maria@linutronix.de>,
	Thomas Gleixner <tglx@linutronix.de>,
	x86@kernel.org, linux-kernel@vger.kernel.org
Subject: [tip: timers/core] tick/sched: Add function description for tick_nohz_next_event()
Date: Mon, 19 Feb 2024 08:45:33 -0000	[thread overview]
Message-ID: <170833233361.398.7577148614843351327.tip-bot2@tip-bot2> (raw)
In-Reply-To: <20240123164702.55612-4-anna-maria@linutronix.de>

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

Commit-ID:     f365d05506150398fe6b035918d6fd8b62f35b9f
Gitweb:        https://git.kernel.org/tip/f365d05506150398fe6b035918d6fd8b62f35b9f
Author:        Anna-Maria Behnsen <anna-maria@linutronix.de>
AuthorDate:    Tue, 23 Jan 2024 17:46:57 +01:00
Committer:     Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Mon, 19 Feb 2024 09:38:00 +01:00

tick/sched: Add function description for tick_nohz_next_event()

The return value of tick_nohz_next_event() is not obvious at the first
glance. Add a kernel-doc compatible function description which also covers
return values.

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-4-anna-maria@linutronix.de

---
 kernel/time/tick-sched.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/kernel/time/tick-sched.c b/kernel/time/tick-sched.c
index 01fb50c..7c9efe3 100644
--- a/kernel/time/tick-sched.c
+++ b/kernel/time/tick-sched.c
@@ -799,6 +799,16 @@ static inline bool local_timer_softirq_pending(void)
 	return local_softirq_pending() & BIT(TIMER_SOFTIRQ);
 }
 
+/**
+ * tick_nohz_next_event() - return the clock monotonic based next event
+ * @ts:		pointer to tick_sched struct
+ * @cpu:	CPU number
+ *
+ * Return:
+ * *%0		- When the next event is a maximum of TICK_NSEC in the future
+ *		  and the tick is not stopped yet
+ * *%next_event	- Next event based on clock monotonic
+ */
 static ktime_t tick_nohz_next_event(struct tick_sched *ts, int cpu)
 {
 	u64 basemono, next_tick, delta, expires;

  reply	other threads:[~2024-02-19  8:45 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-23 16:46 [PATCH 0/8] timers and Documentation: Cleanup Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 1/8] include/hrtimers: Move hrtimer base related definitions into hrtimer_defs Anna-Maria Behnsen
2024-01-25  8:17   ` Thomas Gleixner
2024-01-25 12:20     ` Anna-Maria Behnsen
2024-01-25 13:34       ` Thomas Gleixner
2024-02-19  8:45   ` [tip: timers/core] hrtimers: Move hrtimer base related definitions into hrtimer_defs.h tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 2/8] hrtimers: Update formatting of documentation Anna-Maria Behnsen
2024-02-19  8:45   ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 3/8] tick/sched: Add function description for tick_nohz_next_event() Anna-Maria Behnsen
2024-02-19  8:45   ` tip-bot2 for Anna-Maria Behnsen [this message]
2024-01-23 16:46 ` [PATCH 4/8] timers: Add struct member description for timer_base Anna-Maria Behnsen
2024-02-19  8:45   ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:46 ` [PATCH 5/8] jiffies: Transform comment about time_* functions into DOC block Anna-Maria Behnsen
2024-02-19  8:45   ` [tip: timers/core] " tip-bot2 for Anna-Maria Behnsen
2024-01-23 16:47 ` [PATCH 6/8] Documentation: Create a new folder for all timer internals Anna-Maria Behnsen
2024-01-24  1:26   ` Randy Dunlap
2024-01-25 10:39     ` Anna-Maria Behnsen
2024-01-25 15:00       ` Jonathan Corbet
2024-01-25 15:27         ` Jani Nikula
2024-01-25 16:55           ` Anna-Maria Behnsen
2024-01-25 16:52         ` Anna-Maria Behnsen
2024-01-25 19:50           ` Jonathan Corbet
2024-01-29 13:21             ` Anna-Maria Behnsen
2024-01-23 16:47 ` [PATCH 7/8] Documentation: Move "core core" api into a separate file Anna-Maria Behnsen
2024-01-24  0:57   ` Randy Dunlap
2024-01-25 10:40     ` Anna-Maria Behnsen
2024-01-23 16:47 ` [PATCH 8/8] timers: Add timer wheel documentation Anna-Maria Behnsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=170833233361.398.7577148614843351327.tip-bot2@tip-bot2 \
    --to=tip-bot2@linutronix.de \
    --cc=anna-maria@linutronix.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®