Commit c55cbfce authored by Randy Dunlap's avatar Randy Dunlap Committed by Thomas Gleixner

x86/tsc: Correct kernel-doc notation

Add or modify function descriptions to remove kernel-doc warnings:

tsc.c:655: warning: missing initial short description on line:
 * native_calibrate_tsc
tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc'
tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc'
tsc.c:1373: warning: Function parameter or member 'work' not described in 'tsc_refine_calibration_work'
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20231221033620.32379-1-rdunlap@infradead.org
parent 54be6c6c
...@@ -652,7 +652,7 @@ static unsigned long quick_pit_calibrate(void) ...@@ -652,7 +652,7 @@ static unsigned long quick_pit_calibrate(void)
} }
/** /**
* native_calibrate_tsc * native_calibrate_tsc - determine TSC frequency
* Determine TSC frequency via CPUID, else return 0. * Determine TSC frequency via CPUID, else return 0.
*/ */
unsigned long native_calibrate_tsc(void) unsigned long native_calibrate_tsc(void)
...@@ -1328,9 +1328,9 @@ EXPORT_SYMBOL(convert_art_to_tsc); ...@@ -1328,9 +1328,9 @@ EXPORT_SYMBOL(convert_art_to_tsc);
* *
* Return: * Return:
* struct system_counterval_t - system counter value with the pointer to the * struct system_counterval_t - system counter value with the pointer to the
* corresponding clocksource * corresponding clocksource:
* @cycles: System counter value * cycles: System counter value
* @cs: Clocksource corresponding to system counter value. Used * cs: Clocksource corresponding to system counter value. Used
* by timekeeping code to verify comparability of two cycle * by timekeeping code to verify comparability of two cycle
* values. * values.
*/ */
...@@ -1357,7 +1357,7 @@ static void tsc_refine_calibration_work(struct work_struct *work); ...@@ -1357,7 +1357,7 @@ static void tsc_refine_calibration_work(struct work_struct *work);
static DECLARE_DELAYED_WORK(tsc_irqwork, tsc_refine_calibration_work); static DECLARE_DELAYED_WORK(tsc_irqwork, tsc_refine_calibration_work);
/** /**
* tsc_refine_calibration_work - Further refine tsc freq calibration * tsc_refine_calibration_work - Further refine tsc freq calibration
* @work - ignored. * @work: ignored.
* *
* This functions uses delayed work over a period of a * This functions uses delayed work over a period of a
* second to further refine the TSC freq value. Since this is * second to further refine the TSC freq value. Since this is
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment