Received-SPF: pass (google.com: domain of linux-kernel+bounces-10571-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Message-ID: <24e63b37-0adb-4930-ada0-bfeeb35a7ea5@infradead.org>
Date: Sat, 23 Dec 2023 11:42:51 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc
 description warning
Content-Language: en-US
To: Armin Wolf <W_Armin@gmx.de>, linux-kernel@vger.kernel.org
Cc: Hans de Goede <hdegoede@redhat.com>,
 =?UTF-8?Q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com>,
 platform-driver-x86@vger.kernel.org
References: <20231223050656.14068-1-rdunlap@infradead.org>
 <1dd56bfa-ce60-4037-bb1e-0d1676d4e8ce@gmx.de>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <1dd56bfa-ce60-4037-bb1e-0d1676d4e8ce@gmx.de>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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 <W_Armin@gmx.de>

Thanks. patch v2 is on the way.

> Thanks,
> Armin Wolf
> 
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Armin Wolf <W_Armin@gmx.de>
>> Cc: Hans de Goede <hdegoede@redhat.com>
>> Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
>> Cc: platform-driver-x86@vger.kernel.org
>> ---
>>   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