The following commit has been merged into the timers/core branch of tip: Commit-ID: c92a7eb6c642812fb08851e580973c3b83e0227c Gitweb: https://git.kernel.org/tip/c92a7eb6c642812fb08851e580973c3b83e0227c Author: Anna-Maria Behnsen <anna-maria@xxxxxxxxxxxxx> AuthorDate: Tue, 23 Jan 2024 17:46:59 +01:00 Committer: Thomas Gleixner <tglx@xxxxxxxxxxxxx> CommitterDate: Mon, 19 Feb 2024 09:38:00 +01:00 jiffies: Transform comment about time_* functions into DOC block This general note about time_* functions is also useful to be available in kernel documentation. Therefore transform it into a kernel-doc DOC block with proper formatting. Signed-off-by: Anna-Maria Behnsen <anna-maria@xxxxxxxxxxxxx> Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx> Link: https://lore.kernel.org/r/20240123164702.55612-6-anna-maria@xxxxxxxxxxxxx --- include/linux/jiffies.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h index e0ae2a4..d9f1435 100644 --- a/include/linux/jiffies.h +++ b/include/linux/jiffies.h @@ -102,12 +102,15 @@ static inline u64 get_jiffies_64(void) } #endif -/* - * These inlines deal with timer wrapping correctly. You are - * strongly encouraged to use them: - * 1. Because people otherwise forget - * 2. Because if the timer wrap changes in future you won't have to - * alter your driver code. +/** + * DOC: General information about time_* inlines + * + * These inlines deal with timer wrapping correctly. You are strongly encouraged + * to use them: + * + * #. Because people otherwise forget + * #. Because if the timer wrap changes in future you won't have to alter your + * driver code. */ /**
|