Messages in this thread | | | Date | Tue, 6 Feb 2024 11:54:10 +0100 | From | Peter Hilber <> | Subject | Re: [PATCH v3 1/8] x86/tsc: Fix major kernel-doc warnings for tsc.c |
| |
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 <horms@kernel.org> >> Signed-off-by: Peter Hilber <peter.hilber@opensynergy.com> > > Hi, > or this way: > > https://lore.kernel.org/lkml/20231221033620.32379-1-rdunlap@infradead.org/
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
| |