Re: [PATCH v4 1/6 RESEND] platform/x86: Add lenovo-wmi-* driver Documentation

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1828 bytes --]

On Mon, Mar 17, 2025 at 07:43:21AM -0700, Derek J. Clark wrote:
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +==========================================================
> +Lenovo WMI Interface Gamezone Driver (lenovo-wmi-gamezone)
> +==========================================================
><snipped>...
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +===========================================================
> +Lenovo WMI Interface Other Mode Driver (lenovo-wmi-other)
> +===========================================================

I get htmldocs warnings due to SPDX line not being separated with title
heading:

Documentation/wmi/devices/lenovo-wmi-gamezone.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]
Documentation/wmi/devices/lenovo-wmi-other-method.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]

> +The Other Mode WMI interface uses the firmware_attributes class to expose
> +various WMI attributes provided by the interface in the sysfs. This enables
> +CPU and GPU power limit tuning as well as various other attributes for
> +devices that fall under the "Gaming Series" of Lenovo devices. Each
> +attribute exposed by the Other Mode interface has corresponding
> +capability data blocks which allow the driver to probe details about the
> +attribute. Each attribute has multiple pages, one for each of the platform
> +profiles managed by the Gamezone interface. Attributes are exposed in sysfs
> +under the following path:
> +
> +::
> +/sys/class/firmware-attributes/lenovo-wmi-other/attributes/<attribute>/

sysfs path above isn't outputted as literal code block as it lacks indentation
in the block text.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]