linux-kernel - Re: [PATCH 1/4] platform/x86: wmi: Add kernel doc comments

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] [day] [month] [year] [list]

Message-ID: <3eadc4aa-1271-8ac6-0b29-7faa99234724@infradead.org>
Date:   Mon, 24 Apr 2023 14:30:08 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Armin Wolf <W_Armin@....de>, hdegoede@...hat.com,
        markgross@...nel.org
Cc:     corbet@....net, linux-doc@...r.kernel.org,
        platform-driver-x86@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/4] platform/x86: wmi: Add kernel doc comments



On 4/24/23 14:20, Armin Wolf wrote:
> Am 22.04.23 um 04:54 schrieb Randy Dunlap:
> 
>> Hi,
>>
>> On 4/20/23 16:32, Armin Wolf wrote:
>>> Add kernel doc comments useful for documenting the functions/structs
>>> used to interact with the WMI driver core.
>>>
>>> Signed-off-by: Armin Wolf <W_Armin@....de>
>>> ---
>>>   drivers/platform/x86/wmi.c | 51 +++++++++++++++++++++++++++++++-------
>>>   include/linux/wmi.h        | 41 +++++++++++++++++++++++++++---
>>>   2 files changed, 80 insertions(+), 12 deletions(-)
>>>

>>> +/**
>>> + * struct wmi_device - WMI device structure
>>> + * @dev: Device associated with this WMI device
>>> + * @setable: True for devices implementing the Set Control Method
>> private: fields are not normally documented in kernel-doc.
> 
> Hi,
> 
> since @setable is only used internally by the WMI driver core, i thought it might
> be beneficial to exclude it from the normal driver interface documentation and only
> use it for subsystem-internal documentation.

OK then. :)

-- 
~Randy