Re: [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone

[Armin Wolf <W_Armin@gmx.de>]

Am 15.09.25 um 20:23 schrieb Mark Pearson:

> Hi Ilpo,
>
> On Mon, Sep 15, 2025, at 6:32 AM, Ilpo Järvinen wrote:
>> On Wed, 20 Aug 2025, Mark Pearson wrote:
>>> On Sun, Aug 17, 2025, at 1:06 PM, rakuram wrote:
>>>> Fixed the below typo error
>>>>
>>>> freqency ==> frequency
>>>> in Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>>>
>>>> Signed-off-by: rakuram <rakuram.e96@gmail.com>
>>>> ---
>>>>   Documentation/wmi/devices/lenovo-wmi-gamezone.rst | 2 +-
>>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>>
>>>> diff --git a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>>> b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>>> index 997263e51a7d..22040250a97d 100644
>>>> --- a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>>> +++ b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>>> @@ -153,7 +153,7 @@ data using the `bmfdec
>>>> <https://github.com/pali/bmfdec>`_ utility:
>>>>       [WmiDataId(1), read, Description("P-State ID.")] uint32 PStateID;
>>>>       [WmiDataId(2), read, Description("CLOCK ID.")] uint32 ClockID;
>>>>       [WmiDataId(3), read, Description("Default value.")] uint32
>>>> defaultvalue;
>>>> -    [WmiDataId(4), read, Description("OC Offset freqency.")] uint32
>>>> OCOffsetFreq;
>>>> +    [WmiDataId(4), read, Description("OC Offset frequency.")] uint32
>>>> OCOffsetFreq;
>>>>       [WmiDataId(5), read, Description("OC Min offset value.")] uint32
>>>> OCMinOffset;
>>>>       [WmiDataId(6), read, Description("OC Max offset value.")] uint32
>>>> OCMaxOffset;
>>>>       [WmiDataId(7), read, Description("OC Offset Scale.")] uint32
>>>> OCOffsetScale;
>>>> -- 
>>>> 2.43.0
>>> Looks good to me.
>>> Reviewed-by: Mark Pearson <mpearson-lenovo@squebb.ca>
>> Hi,
>>
>> Isn't the typo in the original interface as well? I'm not very keen in
>> accepting this kind of patches as this part is not really user
>> documentation to begin with.
>>
> I haven't had a chance to double check - but it's kinda bad that we had that typo in the original implementation to be honest. I can ask to get that fixed, but it will likely take a long time for something minor.
> I defer to you on the preference for kernel documentation - I suspect we'll get a bunch of these though (part of the 'getting started to contributing to the kernel' is always typos and documentation right?).
>
> Mark

I agree, the typo is inside the WMI MOF definition which is included inside the documentation for future developers. Since this MOF definition should
match the actual MOF definition reported by the ACPI firmware, i suggest that we ignore any spelling mistakes inside those.

Thanks,
Armin Wolf