Fix the kernel-doc warnings which show up with default arguments for tsc.c:
$ ./scripts/kernel-doc arch/x86/kernel/tsc.c >/dev/null
arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc'
arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc'
arch/x86/kernel/tsc.c:1373: warning: Function parameter or struct member 'work' not described in 'tsc_refine_calibration_work'
The first two warnings stem from members of the convert_art_ns_to_tsc()
return type (struct system_counterval_t). For convert_art_ns_to_tsc(),
the return type members are documented like parameters.
Since these members are already documented with the struct
system_counterval_t definition, remove the redundant documentation for
convert_art_ns_to_tsc(). This resolves the first two warnings.
Fix the third warning by appending a ':' instead of a '-' to the '@work'
documentation parameter.
Suggested-by: Simon Horman <[email protected]>
Signed-off-by: Peter Hilber <[email protected]>
---
Notes:
v3: Added on suggestion of Simon Horman.
arch/x86/kernel/tsc.c | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/arch/x86/kernel/tsc.c b/arch/x86/kernel/tsc.c
index d45084c6a15e..42328f9653c1 100644
--- a/arch/x86/kernel/tsc.c
+++ b/arch/x86/kernel/tsc.c
@@ -1329,10 +1329,6 @@ 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
- * by timekeeping code to verify comparability of two cycle
- * values.
*/
struct system_counterval_t convert_art_ns_to_tsc(u64 art_ns)
@@ -1357,7 +1353,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.40.1
On 1/31/24 17:04, Peter Hilber wrote:
> Fix the kernel-doc warnings which show up with default arguments for tsc.c:
>
> $ ./scripts/kernel-doc arch/x86/kernel/tsc.c >/dev/null
> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc'
> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc'
> arch/x86/kernel/tsc.c:1373: warning: Function parameter or struct member 'work' not described in 'tsc_refine_calibration_work'
>
> The first two warnings stem from members of the convert_art_ns_to_tsc()
> return type (struct system_counterval_t). For convert_art_ns_to_tsc(),
> the return type members are documented like parameters.
>
> Since these members are already documented with the struct
> system_counterval_t definition, remove the redundant documentation for
> convert_art_ns_to_tsc(). This resolves the first two warnings.
>
> Fix the third warning by appending a ':' instead of a '-' to the '@work'
> documentation parameter.
>
> Suggested-by: Simon Horman <[email protected]>
> Signed-off-by: Peter Hilber <[email protected]>
Hi,
or this way:
https://lore.kernel.org/lkml/[email protected]/
Thanks.
> ---
>
> Notes:
> v3: Added on suggestion of Simon Horman.
>
> arch/x86/kernel/tsc.c | 6 +-----
> 1 file changed, 1 insertion(+), 5 deletions(-)
>
> diff --git a/arch/x86/kernel/tsc.c b/arch/x86/kernel/tsc.c
> index d45084c6a15e..42328f9653c1 100644
> --- a/arch/x86/kernel/tsc.c
> +++ b/arch/x86/kernel/tsc.c
> @@ -1329,10 +1329,6 @@ 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
> - * by timekeeping code to verify comparability of two cycle
> - * values.
> */
>
> struct system_counterval_t convert_art_ns_to_tsc(u64 art_ns)
> @@ -1357,7 +1353,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
--
#Randy
On 01.02.24 05:52, Randy Dunlap wrote:
>
>
> On 1/31/24 17:04, Peter Hilber wrote:
>> Fix the kernel-doc warnings which show up with default arguments for tsc.c:
>>
>> $ ./scripts/kernel-doc arch/x86/kernel/tsc.c >/dev/null
>> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc'
>> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc'
>> arch/x86/kernel/tsc.c:1373: warning: Function parameter or struct member 'work' not described in 'tsc_refine_calibration_work'
>>
>> The first two warnings stem from members of the convert_art_ns_to_tsc()
>> return type (struct system_counterval_t). For convert_art_ns_to_tsc(),
>> the return type members are documented like parameters.
>>
>> Since these members are already documented with the struct
>> system_counterval_t definition, remove the redundant documentation for
>> convert_art_ns_to_tsc(). This resolves the first two warnings.
>>
>> Fix the third warning by appending a ':' instead of a '-' to the '@work'
>> documentation parameter.
>>
>> Suggested-by: Simon Horman <[email protected]>
>> Signed-off-by: Peter Hilber <[email protected]>
>
> Hi,
> or this way:
>
> https://lore.kernel.org/lkml/[email protected]/
Thanks for the link! I did not see your patch, I think I could add it to my
patch series instead of my patch.
Best regards,
Peter
On 2/6/24 02:54, Peter Hilber wrote:
> On 01.02.24 05:52, Randy Dunlap wrote:
>>
>>
>> On 1/31/24 17:04, Peter Hilber wrote:
>>> Fix the kernel-doc warnings which show up with default arguments for tsc.c:
>>>
>>> $ ./scripts/kernel-doc arch/x86/kernel/tsc.c >/dev/null
>>> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc'
>>> arch/x86/kernel/tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc'
>>> arch/x86/kernel/tsc.c:1373: warning: Function parameter or struct member 'work' not described in 'tsc_refine_calibration_work'
>>>
>>> The first two warnings stem from members of the convert_art_ns_to_tsc()
>>> return type (struct system_counterval_t). For convert_art_ns_to_tsc(),
>>> the return type members are documented like parameters.
>>>
>>> Since these members are already documented with the struct
>>> system_counterval_t definition, remove the redundant documentation for
>>> convert_art_ns_to_tsc(). This resolves the first two warnings.
>>>
>>> Fix the third warning by appending a ':' instead of a '-' to the '@work'
>>> documentation parameter.
>>>
>>> Suggested-by: Simon Horman <[email protected]>
>>> Signed-off-by: Peter Hilber <[email protected]>
>>
>> Hi,
>> or this way:
>>
>> https://lore.kernel.org/lkml/[email protected]/
>
> Thanks for the link! I did not see your patch, I think I could add it to my
> patch series instead of my patch.
Sure, go with it. :)
thanks.
--
#Randy