Re: [PATCH v2 0/4] platform/x86: wmi: Add subsystem documentation

[Hans de Goede <hdegoede@redhat.com>]

Hi Armin,

On 4/25/23 00:29, Armin Wolf wrote:
> Currently, there is no recent documentation available for writing WMI
> drivers using the modern bus-based interface. This leads to developers
> using the deprecated GUID-based interface when developing new drivers,
> causing issues with notification handling when multiple WMI devices sharing
> the same notification ID are present. There is also no way for WMI
> drivers to add device specific documentation at the moment.
> Add documentation for the WMI subsystem to solve those issues. The
> device specific documentation currently onyl include documentation for
> the wmi-bmof driver, but more is expected to follow.

Thank you for your patch series, I've applied this series
to my review-hans branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Patches which are added to review-hans now are intended for
the next rc1. This branch will get rebased to the next rc1 when
it is out and after the rebasing the contents of review-hans
will be pushed to the platform-drivers-x86/for-next branch.

Regards,

Hans


> ---
> Changes in v2:
> - spelling fixes
> - tell readers that MOF means Managed Object Format
> - 80-cloumn limit
> 
> Armin Wolf (4):
>   platform/x86: wmi: Add kernel doc comments
>   platform/x86: wmi: Mark GUID-based WMI interface as deprecated
>   platform/x86: wmi: Add documentation
>   platform/x86: wmi: Add device specific documentation
> 
>  .../ABI/stable/sysfs-platform-wmi-bmof        |  7 ++
>  Documentation/driver-api/index.rst            |  1 +
>  Documentation/driver-api/wmi.rst              | 21 ++++
>  Documentation/subsystem-apis.rst              |  1 +
>  Documentation/wmi/acpi-interface.rst          | 96 +++++++++++++++++++
>  Documentation/wmi/devices/index.rst           | 22 +++++
>  Documentation/wmi/devices/wmi-bmof.rst        | 25 +++++
>  Documentation/wmi/index.rst                   | 19 ++++
>  MAINTAINERS                                   |  9 ++
>  drivers/platform/x86/Kconfig                  |  4 +-
>  drivers/platform/x86/wmi.c                    | 63 +++++++++---
>  include/linux/wmi.h                           | 41 +++++++-
>  12 files changed, 289 insertions(+), 20 deletions(-)
>  create mode 100644 Documentation/ABI/stable/sysfs-platform-wmi-bmof
>  create mode 100644 Documentation/driver-api/wmi.rst
>  create mode 100644 Documentation/wmi/acpi-interface.rst
>  create mode 100644 Documentation/wmi/devices/index.rst
>  create mode 100644 Documentation/wmi/devices/wmi-bmof.rst
>  create mode 100644 Documentation/wmi/index.rst
> 
> --
> 2.30.2
>