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] hrtimers: Update formatting of documentation
Date: Mon, 19 Feb 2024 08:45:34 -0000	[thread overview]
Message-ID: <170833233427.398.8658313899755655344.tip-bot2@tip-bot2> (raw)
In-Reply-To: <20240123164702.55612-3-anna-maria@linutronix.de>

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

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

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

---
 include/linux/hrtimer.h | 14 +++-----------
 kernel/time/hrtimer.c   | 18 ++++++++++--------
 2 files changed, 13 insertions(+), 19 deletions(-)

diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h
index 792a0ac..aa1e65c 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)
diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c
index 7607939..4c8dd63 100644
--- a/kernel/time/hrtimer.c
+++ b/kernel/time/hrtimer.c
@@ -1021,21 +1021,23 @@ void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
 }
 
 /**
- * hrtimer_forward - forward the timer expiry
+ * hrtimer_forward() - forward the timer expiry
  * @timer:	hrtimer to forward
  * @now:	forward past this time
  * @interval:	the interval to forward
  *
  * Forward the timer expiry so it will expire in the future.
- * 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.
  *
- * Note: This only updates the timer expiry value and does not requeue
- * the timer.
+ * There is also a variant of the function hrtimer_forward_now().
+ *
+ * Context: 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.
+ *
+ * Return: The number of overruns are returned.
  */
 u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
 {

  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-bot2 for Anna-Maria Behnsen [this message]
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: timers/core] " tip-bot2 for Anna-Maria Behnsen
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=170833233427.398.8658313899755655344.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®