hrtimer: Fix kernel-doc markups (66981c37) · Commits · 戴 / test

The hrtimer_get_remaining() markup is documenting, instead, __hrtimer_get_remaining(), as it is placed at the C file. In order to properly document it, a kernel-doc markup is needed together with the function prototype. So, add a new one, while preserving the existing one, just fixing the function name. The hrtimer_is_queued prototype has a typo: it is using '=' instead of '-' to split: identifier - description as required by kernel-doc markup. Signed-off-by:

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by:

Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/r/9dc87808c2fd07b7e050bafcd033c5ef05808fea.1605521731.git.mchehab+huawei@kernel.org

include/linux/hrtimer.h

+5 −1

Original line number	Diff line number	Diff line
		@@ -447,6 +447,10 @@ static inline void hrtimer_restart(struct hrtimer *timer)
		/* Query timers: */
		extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);

		/**
		* hrtimer_get_remaining - get remaining time for the timer
		* @timer: the timer to read
		*/
		static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
		{
		return __hrtimer_get_remaining(timer, false);
		@@ -458,7 +462,7 @@ extern u64 hrtimer_next_event_without(const struct hrtimer *exclude);
		extern bool hrtimer_active(const struct hrtimer *timer);

		/**
		* hrtimer_is_queued = check, whether the timer is on one of the queues
		* hrtimer_is_queued - check, whether the timer is on one of the queues
		* @timer: Timer to check
		*
		* Returns: True if the timer is queued, false otherwise

kernel/time/hrtimer.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -1289,7 +1289,7 @@ int hrtimer_cancel(struct hrtimer *timer)
		EXPORT_SYMBOL_GPL(hrtimer_cancel);

		/**
		* hrtimer_get_remaining - get remaining time for the timer
		* __hrtimer_get_remaining - get remaining time for the timer
		* @timer: the timer to read
		* @adjust: adjust relative timers when CONFIG_TIME_LOW_RES=y
		*/

Admin message