On Sun, Dec 24 2023 at 16:27, Simon Horman wrote:
> On Fri, Dec 15, 2023 at 11:06:07PM +0100, Peter Hilber wrote:
>> @@ -1327,12 +1334,15 @@ EXPORT_SYMBOL(convert_art_to_tsc);
>> * that this flag is set before conversion to TSC is attempted.
>> *
>> * Return:
>> - * struct system_counterval_t - system counter value with the pointer to the
>> + * struct system_counterval_t - system counter value with the ID of 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.
>> + * @cs_id: Clocksource ID corresponding to system counter value.
>> + * Used by timekeeping code to verify comparability of two
>> + * cycle values.
>
> None of the documented parameters to convert_art_ns_to_tsc() above
> correspond to the parameters of convert_art_ns_to_tsc() below.
Obviously not because they document the return value. The sole argument
of the function @art_ns is documented correctly.
> The same patch that corrects the kernel doc for convert_art_ns_to_tsc()
> could also correct the kernel doc for tsc_refine_calibration_work()
> by documenting it's work parameter.
That's a separate cleanup. Feel free to send a patch for that.
Thanks,
tglx
