2023-12-23 05:07:53

by Randy Dunlap

Subject: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc description warning

Remove the "private:" comment to prevent the kernel-doc warning:

include/linux/wmi.h:27: warning: Excess struct member 'setable' description in 'wmi_device'

Either a struct member is documented (via kernel-doc) or it's private,
but not both.

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Armin Wolf <[email protected]>
Cc: Hans de Goede <[email protected]>
Cc: Ilpo Järvinen <[email protected]>
Cc: [email protected]
---
include/linux/wmi.h | 2 --
1 file changed, 2 deletions(-)

diff -- a/include/linux/wmi.h b/include/linux/wmi.h
--- a/include/linux/wmi.h
+++ b/include/linux/wmi.h
@@ -21,8 +21,6 @@
*/
struct wmi_device {
struct device dev;
-
- /* private: used by the WMI driver core */
bool setable;
};

2023-12-23 19:43:03

by Randy Dunlap

Subject: Re: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc description warning

Hi Armin,

On 12/22/23 22:48, Armin Wolf wrote:
> Am 23.12.23 um 06:06 schrieb Randy Dunlap:
>
>> Remove the "private:" comment to prevent the kernel-doc warning:
>>
>> include/linux/wmi.h:27: warning: Excess struct member 'setable' description in 'wmi_device'
>>
>> Either a struct member is documented (via kernel-doc) or it's private,
>> but not both.
>
> Hi,
>
> i am not encountering this kernel doc warning, but your argument is still valid. I also seem to
> have missed the fact that WMI drivers may want to know whether their WMI data block is setable
> during runtime when i added those kernel-doc comments.

The warning comes from 2 new patches in linux-next.

> Please add a Fixes: b4cc979588ee ("platform/x86: wmi: Add kernel doc comments") tag so that
> this patch can reach the stable kernels. With that addressed, you may also add:
>
> Reviewed-by: Armin Wolf <[email protected]>

Thanks. patch v2 is on the way.

> Thanks,
> Armin Wolf
>
>> Signed-off-by: Randy Dunlap <[email protected]>
>> Cc: Armin Wolf <[email protected]>
>> Cc: Hans de Goede <[email protected]>
>> Cc: Ilpo Järvinen <[email protected]>
>> Cc: [email protected]
>> ---
>>   include/linux/wmi.h |    2 --
>>   1 file changed, 2 deletions(-)
>>
>> diff -- a/include/linux/wmi.h b/include/linux/wmi.h
>> --- a/include/linux/wmi.h
>> +++ b/include/linux/wmi.h
>> @@ -21,8 +21,6 @@
>>    */
>>   struct wmi_device {
>>       struct device dev;
>> -
>> -    /* private: used by the WMI driver core */
>>       bool setable;
>>   };
>>

--
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html