Skip to content

Commit c55cbfc

Browse files
rddunlapKAGA-KOKO
authored andcommitted
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: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/r/20231221033620.32379-1-rdunlap@infradead.org
1 parent 54be6c6 commit c55cbfc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

arch/x86/kernel/tsc.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ static unsigned long quick_pit_calibrate(void)
652652
}
653653

654654
/**
655-
* native_calibrate_tsc
655+
* native_calibrate_tsc - determine TSC frequency
656656
* Determine TSC frequency via CPUID, else return 0.
657657
*/
658658
unsigned long native_calibrate_tsc(void)
@@ -1328,9 +1328,9 @@ EXPORT_SYMBOL(convert_art_to_tsc);
13281328
*
13291329
* Return:
13301330
* struct system_counterval_t - system counter value with the pointer to the
1331-
* corresponding clocksource
1332-
* @cycles: System counter value
1333-
* @cs: Clocksource corresponding to system counter value. Used
1331+
* corresponding clocksource:
1332+
* cycles: System counter value
1333+
* cs: Clocksource corresponding to system counter value. Used
13341334
* by timekeeping code to verify comparability of two cycle
13351335
* values.
13361336
*/
@@ -1357,7 +1357,7 @@ static void tsc_refine_calibration_work(struct work_struct *work);
13571357
static DECLARE_DELAYED_WORK(tsc_irqwork, tsc_refine_calibration_work);
13581358
/**
13591359
* tsc_refine_calibration_work - Further refine tsc freq calibration
1360-
* @work - ignored.
1360+
* @work: ignored.
13611361
*
13621362
* This functions uses delayed work over a period of a
13631363
* second to further refine the TSC freq value. Since this is

0 commit comments

Comments
 (0)