linux-kernel - Re: [PATCH v3 1/8] x86/tsc: Fix major kernel-doc warnings for tsc.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <e25f9bc4-4155-4b55-bebd-48ae18fe856b@opensynergy.com>
Date: Tue, 6 Feb 2024 11:54:10 +0100
From: Peter Hilber <peter.hilber@...nsynergy.com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Simon Horman <horms@...nel.org>,
 "D, Lakshmi Sowjanya" <lakshmi.sowjanya.d@...el.com>,
 Thomas Gleixner <tglx@...utronix.de>, jstultz@...gle.com,
 giometti@...eenne.com, corbet@....net, "Dong, Eddie" <eddie.dong@...el.com>,
 "Hall, Christopher S" <christopher.s.hall@...el.com>,
 Andy Shevchenko <andriy.shevchenko@...ux.intel.com>, x86@...nel.org,
 Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
 Dave Hansen <dave.hansen@...ux.intel.com>, "H. Peter Anvin" <hpa@...or.com>
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 '@...k'
>> documentation parameter.
>>
>> Suggested-by: Simon Horman <horms@...nel.org>
>> Signed-off-by: Peter Hilber <peter.hilber@...nsynergy.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