2021-06-10 11:35:25

by Baokun Li

[permalink] [raw]
Subject: [PATCH -next] x86/tsc: fix doc warnings in tsc.c

Fixes the following W=1 kernel build warning(s):

arch/x86/kernel/tsc.c:1275: warning: Excess function
parameter 'cycles' description in 'convert_art_ns_to_tsc'
arch/x86/kernel/tsc.c:1275: warning: Excess function
parameter 'cs' description in 'convert_art_ns_to_tsc'
arch/x86/kernel/tsc.c:1309: warning: Function parameter or
member 'work' not described in 'tsc_refine_calibration_work'

Signed-off-by: Baokun Li <[email protected]>
---
arch/x86/kernel/tsc.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/arch/x86/kernel/tsc.c b/arch/x86/kernel/tsc.c
index 2e076a459a0c..312591c8e3d6 100644
--- a/arch/x86/kernel/tsc.c
+++ b/arch/x86/kernel/tsc.c
@@ -1265,8 +1265,8 @@ EXPORT_SYMBOL(convert_art_to_tsc);
* Return:
* struct system_counterval_t - system counter value with the pointer to the
* corresponding clocksource
- * @cycles: System counter value
- * @cs: Clocksource corresponding to system counter value. Used
+ * cycles: System counter value
+ * cs: Clocksource corresponding to system counter value. Used
* by timekeeping code to verify comparability of two cycle
* values.
*/
@@ -1293,7 +1293,7 @@ static void tsc_refine_calibration_work(struct work_struct *work);
static DECLARE_DELAYED_WORK(tsc_irqwork, tsc_refine_calibration_work);
/**
* tsc_refine_calibration_work - Further refine tsc freq calibration
- * @work - ignored.
+ * @work: ignored.
*
* This functions uses delayed work over a period of a
* second to further refine the TSC freq value. Since this is
--
2.31.1