mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-26 20:38:12 +00:00
time: Fix various kernel-doc problems
Clean up kernel-doc complaints about function names and non-kernel-doc comments in kernel/time/. Fixes these warnings: kernel/time/time.c:479: warning: expecting prototype for set_normalized_timespec(). Prototype was for set_normalized_timespec64() instead kernel/time/time.c:553: warning: expecting prototype for msecs_to_jiffies(). Prototype was for __msecs_to_jiffies() instead kernel/time/timekeeping.c:1595: warning: contents before sections kernel/time/timekeeping.c:1705: warning: This comment starts with '/**', but isn't a kernel-doc comment. * We have three kinds of time sources to use for sleep time kernel/time/timekeeping.c:1726: warning: This comment starts with '/**', but isn't a kernel-doc comment. * 1) can be determined whether to use or not only when doing kernel/time/tick-oneshot.c:21: warning: missing initial short description on line: * tick_program_event kernel/time/tick-oneshot.c:107: warning: expecting prototype for tick_check_oneshot_mode(). Prototype was for tick_oneshot_mode_active() instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Ingo Molnar <mingo@kernel.org> Link: https://lore.kernel.org/r/20230103032849.12723-1-rdunlap@infradead.org
This commit is contained in:
parent
69b41ac87e
commit
f3cb80804b
3 changed files with 10 additions and 10 deletions
|
@ -18,7 +18,7 @@
|
||||||
#include "tick-internal.h"
|
#include "tick-internal.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* tick_program_event
|
* tick_program_event - program the CPU local timer device for the next event
|
||||||
*/
|
*/
|
||||||
int tick_program_event(ktime_t expires, int force)
|
int tick_program_event(ktime_t expires, int force)
|
||||||
{
|
{
|
||||||
|
@ -99,7 +99,7 @@ int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *))
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* tick_check_oneshot_mode - check whether the system is in oneshot mode
|
* tick_oneshot_mode_active - check whether the system is in oneshot mode
|
||||||
*
|
*
|
||||||
* returns 1 when either nohz or highres are enabled. otherwise 0.
|
* returns 1 when either nohz or highres are enabled. otherwise 0.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -462,7 +462,7 @@ struct __kernel_old_timeval ns_to_kernel_old_timeval(s64 nsec)
|
||||||
EXPORT_SYMBOL(ns_to_kernel_old_timeval);
|
EXPORT_SYMBOL(ns_to_kernel_old_timeval);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* set_normalized_timespec - set timespec sec and nsec parts and normalize
|
* set_normalized_timespec64 - set timespec sec and nsec parts and normalize
|
||||||
*
|
*
|
||||||
* @ts: pointer to timespec variable to be set
|
* @ts: pointer to timespec variable to be set
|
||||||
* @sec: seconds to set
|
* @sec: seconds to set
|
||||||
|
@ -526,7 +526,7 @@ struct timespec64 ns_to_timespec64(s64 nsec)
|
||||||
EXPORT_SYMBOL(ns_to_timespec64);
|
EXPORT_SYMBOL(ns_to_timespec64);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* msecs_to_jiffies: - convert milliseconds to jiffies
|
* __msecs_to_jiffies: - convert milliseconds to jiffies
|
||||||
* @m: time in milliseconds
|
* @m: time in milliseconds
|
||||||
*
|
*
|
||||||
* conversion is done as follows:
|
* conversion is done as follows:
|
||||||
|
@ -541,12 +541,12 @@ EXPORT_SYMBOL(ns_to_timespec64);
|
||||||
* handling any 32-bit overflows.
|
* handling any 32-bit overflows.
|
||||||
* for the details see __msecs_to_jiffies()
|
* for the details see __msecs_to_jiffies()
|
||||||
*
|
*
|
||||||
* msecs_to_jiffies() checks for the passed in value being a constant
|
* __msecs_to_jiffies() checks for the passed in value being a constant
|
||||||
* via __builtin_constant_p() allowing gcc to eliminate most of the
|
* via __builtin_constant_p() allowing gcc to eliminate most of the
|
||||||
* code, __msecs_to_jiffies() is called if the value passed does not
|
* code, __msecs_to_jiffies() is called if the value passed does not
|
||||||
* allow constant folding and the actual conversion must be done at
|
* allow constant folding and the actual conversion must be done at
|
||||||
* runtime.
|
* runtime.
|
||||||
* the _msecs_to_jiffies helpers are the HZ dependent conversion
|
* The _msecs_to_jiffies helpers are the HZ dependent conversion
|
||||||
* routines found in include/linux/jiffies.h
|
* routines found in include/linux/jiffies.h
|
||||||
*/
|
*/
|
||||||
unsigned long __msecs_to_jiffies(const unsigned int m)
|
unsigned long __msecs_to_jiffies(const unsigned int m)
|
||||||
|
|
|
@ -1590,10 +1590,10 @@ void __weak read_persistent_clock64(struct timespec64 *ts)
|
||||||
/**
|
/**
|
||||||
* read_persistent_wall_and_boot_offset - Read persistent clock, and also offset
|
* read_persistent_wall_and_boot_offset - Read persistent clock, and also offset
|
||||||
* from the boot.
|
* from the boot.
|
||||||
|
* @wall_time: current time as returned by persistent clock
|
||||||
|
* @boot_offset: offset that is defined as wall_time - boot_time
|
||||||
*
|
*
|
||||||
* Weak dummy function for arches that do not yet support it.
|
* Weak dummy function for arches that do not yet support it.
|
||||||
* @wall_time: - current time as returned by persistent clock
|
|
||||||
* @boot_offset: - offset that is defined as wall_time - boot_time
|
|
||||||
*
|
*
|
||||||
* The default function calculates offset based on the current value of
|
* The default function calculates offset based on the current value of
|
||||||
* local_clock(). This way architectures that support sched_clock() but don't
|
* local_clock(). This way architectures that support sched_clock() but don't
|
||||||
|
@ -1701,7 +1701,7 @@ static void __timekeeping_inject_sleeptime(struct timekeeper *tk,
|
||||||
}
|
}
|
||||||
|
|
||||||
#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
|
#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
|
||||||
/**
|
/*
|
||||||
* We have three kinds of time sources to use for sleep time
|
* We have three kinds of time sources to use for sleep time
|
||||||
* injection, the preference order is:
|
* injection, the preference order is:
|
||||||
* 1) non-stop clocksource
|
* 1) non-stop clocksource
|
||||||
|
@ -1722,7 +1722,7 @@ bool timekeeping_rtc_skipresume(void)
|
||||||
return !suspend_timing_needed;
|
return !suspend_timing_needed;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* 1) can be determined whether to use or not only when doing
|
* 1) can be determined whether to use or not only when doing
|
||||||
* timekeeping_resume() which is invoked after rtc_suspend(),
|
* timekeeping_resume() which is invoked after rtc_suspend(),
|
||||||
* so we can't skip rtc_suspend() surely if system has 1).
|
* so we can't skip rtc_suspend() surely if system has 1).
|
||||||
|
|
Loading…
Reference in a new issue