From: "tip-bot2 for Sunday Adelodun" <tip-bot2@linutronix.de>
To: linux-tip-commits@vger.kernel.org
Cc: Sunday Adelodun <adelodunolaoluwa@yahoo.com>,
Thomas Gleixner <tglx@linutronix.de>,
x86@kernel.org, linux-kernel@vger.kernel.org
Subject: [tip: timers/core] time: tick-oneshot: Add missing Return and parameter descriptions to kernel-doc
Date: Fri, 14 Nov 2025 19:21:57 -0000 [thread overview]
Message-ID: <176314811769.498.2165775959713741464.tip-bot2@tip-bot2> (raw)
In-Reply-To: <20251106113938.34693-3-adelodunolaoluwa@yahoo.com>
The following commit has been merged into the timers/core branch of tip:
Commit-ID: e54dd0474c281ebcd32ada4bdbe1e0ada2e1c22b
Gitweb: https://git.kernel.org/tip/e54dd0474c281ebcd32ada4bdbe1e0ada2e1c22b
Author: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
AuthorDate: Thu, 06 Nov 2025 12:39:38 +01:00
Committer: Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Fri, 14 Nov 2025 20:17:44 +01:00
time: tick-oneshot: Add missing Return and parameter descriptions to kernel-doc
Several functions in kernel/time/tick-oneshot.c are missing parameter and
return value descriptions in their kernel-doc comments. This causes
warnings during doc generation.
Update the kernel-doc blocks to include detailed @param and Return:
descriptions for better clarity and to fix kernel-doc warnings. No
functional code changes are made.
Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://patch.msgid.link/20251106113938.34693-3-adelodunolaoluwa@yahoo.com
---
kernel/time/tick-oneshot.c | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/kernel/time/tick-oneshot.c b/kernel/time/tick-oneshot.c
index 5e2c2c2..ffee943 100644
--- a/kernel/time/tick-oneshot.c
+++ b/kernel/time/tick-oneshot.c
@@ -19,6 +19,10 @@
/**
* tick_program_event - program the CPU local timer device for the next event
+ * @expires: the time at which the next timer event should occur
+ * @force: flag to force reprograming even if the event time hasn't changed
+ *
+ * Return: 0 on success, negative error code on failure
*/
int tick_program_event(ktime_t expires, int force)
{
@@ -57,6 +61,13 @@ void tick_resume_oneshot(void)
/**
* tick_setup_oneshot - setup the event device for oneshot mode (hres or nohz)
+ * @newdev: Pointer to the clock event device to configure
+ * @handler: Function to be called when the event device triggers an interrupt
+ * @next_event: Initial expiry time for the next event (in ktime)
+ *
+ * Configures the specified clock event device for onshot mode,
+ * assigns the given handler as its event callback, and programs
+ * the device to trigger at the specified next event time.
*/
void tick_setup_oneshot(struct clock_event_device *newdev,
void (*handler)(struct clock_event_device *),
@@ -69,6 +80,10 @@ void tick_setup_oneshot(struct clock_event_device *newdev,
/**
* tick_switch_to_oneshot - switch to oneshot mode
+ * @handler: function to call when an event occurs on the tick device
+ *
+ * Return: 0 on success, -EINVAL if the tick device is not present,
+ * not functional, or does not support oneshot mode.
*/
int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *))
{
@@ -101,7 +116,7 @@ int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *))
/**
* tick_oneshot_mode_active - check whether the system is in oneshot mode
*
- * returns 1 when either nohz or highres are enabled. otherwise 0.
+ * Return: 1 when either nohz or highres are enabled, otherwise 0.
*/
int tick_oneshot_mode_active(void)
{
@@ -120,6 +135,9 @@ int tick_oneshot_mode_active(void)
* tick_init_highres - switch to high resolution mode
*
* Called with interrupts disabled.
+ *
+ * Return: 0 on success, -EINVAL if the tick device cannot switch
+ * to oneshot/high-resolution mode.
*/
int tick_init_highres(void)
{
prev parent reply other threads:[~2025-11-14 19:22 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20251106113938.34693-1-adelodunolaoluwa.ref@yahoo.com>
2025-11-06 11:39 ` [PATCH 0/2] Fix kernel-doc warnings in power and time Sunday Adelodun
2025-11-06 11:39 ` [PATCH 1/2] power/swap: add missing params and Return: descriptions to kernel-doc comments Sunday Adelodun
2025-11-07 15:36 ` Rafael J. Wysocki
2025-11-07 19:58 ` Sunday Adelodun
2025-11-07 20:19 ` Rafael J. Wysocki
2025-11-06 11:39 ` [PATCH 2/2] time: tick-oneshot: add missing Return: and param descriptions to kernel-doc Sunday Adelodun
2025-11-14 19:21 ` tip-bot2 for Sunday Adelodun [this message]
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=176314811769.498.2165775959713741464.tip-bot2@tip-bot2 \
--to=tip-bot2@linutronix.de \
--cc=adelodunolaoluwa@yahoo.com \
--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®