public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
* [PATCH] Documentation/wmi: Fix Typo Error in doc
@ 2025-08-20 15:58 Alperen Aksu
  2025-08-20 23:21 ` Derek J. Clark
  0 siblings, 1 reply; 4+ messages in thread
From: Alperen Aksu @ 2025-08-20 15:58 UTC (permalink / raw)
  To: mpearson-lenovo, derekjohn.clark
  Cc: platform-driver-x86, skhan, linux-kernel-mentees, Alperen Aksu

Fix to correct spelling of "Hardware"

Signed-off-by: Alperen Aksu <aksulperen@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..24b027362e93 100644
--- a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
+++ b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
@@ -126,7 +126,7 @@ data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
     [WmiMethodId(65), Implemented, Description("Set IGPU Mode")] void SetIGPUModeStatus([in, Description("IGPU Mode")] UINT32 mode, [out, Description("return code")] UINT32 Data);
     [WmiMethodId(66), Implemented, Description("Notify DGPU Status")] void NotifyDGPUStatus([in, Description("DGPU status")] UINT32 status, [out, Description("return code")] UINT32 Data);
     [WmiMethodId(67), Implemented, Description("Is changed Y log")] void IsChangedYLog([out, Description("Is changed Y Log")] UINT32 Data);
-    [WmiMethodId(68), Implemented, Description("Get DGPU Hardwawre ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
+    [WmiMethodId(68), Implemented, Description("Get DGPU Hardware ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
   };
 
   [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("Definition of CPU OC parameter list"), guid("{B7F3CA0A-ACDC-42D2-9217-77C6C628FBD2}")]
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] Documentation/wmi: Fix Typo Error in doc
  2025-08-20 15:58 [PATCH] Documentation/wmi: Fix Typo Error in doc Alperen Aksu
@ 2025-08-20 23:21 ` Derek J. Clark
  2025-09-15 10:13   ` Ilpo Järvinen
  0 siblings, 1 reply; 4+ messages in thread
From: Derek J. Clark @ 2025-08-20 23:21 UTC (permalink / raw)
  To: Alperen Aksu, mpearson-lenovo
  Cc: platform-driver-x86, skhan, linux-kernel-mentees



On August 20, 2025 8:58:35 AM PDT, Alperen Aksu <aksulperen@gmail.com> wrote:
>Fix to correct spelling of "Hardware"
>
Hi Alperen, 

While we can fix the spelling of these, they are currently as provided by Lenovo. The spelling error exists in the WMI interfaces and during development we decided to leave them wrong to match.

- Derek

>Signed-off-by: Alperen Aksu <aksulperen@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..24b027362e93 100644
>--- a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>+++ b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>@@ -126,7 +126,7 @@ data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
>     [WmiMethodId(65), Implemented, Description("Set IGPU Mode")] void SetIGPUModeStatus([in, Description("IGPU Mode")] UINT32 mode, [out, Description("return code")] UINT32 Data);
>     [WmiMethodId(66), Implemented, Description("Notify DGPU Status")] void NotifyDGPUStatus([in, Description("DGPU status")] UINT32 status, [out, Description("return code")] UINT32 Data);
>     [WmiMethodId(67), Implemented, Description("Is changed Y log")] void IsChangedYLog([out, Description("Is changed Y Log")] UINT32 Data);
>-    [WmiMethodId(68), Implemented, Description("Get DGPU Hardwawre ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
>+    [WmiMethodId(68), Implemented, Description("Get DGPU Hardware ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
>   };
> 
>   [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("Definition of CPU OC parameter list"), guid("{B7F3CA0A-ACDC-42D2-9217-77C6C628FBD2}")]

- Derek

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Documentation/wmi: Fix Typo Error in doc
  2025-08-20 23:21 ` Derek J. Clark
@ 2025-09-15 10:13   ` Ilpo Järvinen
  2025-09-15 21:49     ` Armin Wolf
  0 siblings, 1 reply; 4+ messages in thread
From: Ilpo Järvinen @ 2025-09-15 10:13 UTC (permalink / raw)
  To: Derek J. Clark, Alperen Aksu
  Cc: Mark Pearson, platform-driver-x86, skhan, linux-kernel-mentees

On Wed, 20 Aug 2025, Derek J. Clark wrote:
> On August 20, 2025 8:58:35 AM PDT, Alperen Aksu <aksulperen@gmail.com> wrote:
> >Fix to correct spelling of "Hardware"
> >
> Hi Alperen, 
> 
> While we can fix the spelling of these, they are currently as provided by Lenovo. The spelling error exists in the WMI interfaces and during development we decided to leave them wrong to match.

Yes, I'm not keen on accepting patches like this.

These are hardly something user reads as documentation anyway.

> - Derek
> 
> >Signed-off-by: Alperen Aksu <aksulperen@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..24b027362e93 100644
> >--- a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> >+++ b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
> >@@ -126,7 +126,7 @@ data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
> >     [WmiMethodId(65), Implemented, Description("Set IGPU Mode")] void SetIGPUModeStatus([in, Description("IGPU Mode")] UINT32 mode, [out, Description("return code")] UINT32 Data);
> >     [WmiMethodId(66), Implemented, Description("Notify DGPU Status")] void NotifyDGPUStatus([in, Description("DGPU status")] UINT32 status, [out, Description("return code")] UINT32 Data);
> >     [WmiMethodId(67), Implemented, Description("Is changed Y log")] void IsChangedYLog([out, Description("Is changed Y Log")] UINT32 Data);
> >-    [WmiMethodId(68), Implemented, Description("Get DGPU Hardwawre ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
> >+    [WmiMethodId(68), Implemented, Description("Get DGPU Hardware ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
> >   };
> > 
> >   [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("Definition of CPU OC parameter list"), guid("{B7F3CA0A-ACDC-42D2-9217-77C6C628FBD2}")]
> 
> - Derek
> 

-- 
 i.


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Documentation/wmi: Fix Typo Error in doc
  2025-09-15 10:13   ` Ilpo Järvinen
@ 2025-09-15 21:49     ` Armin Wolf
  0 siblings, 0 replies; 4+ messages in thread
From: Armin Wolf @ 2025-09-15 21:49 UTC (permalink / raw)
  To: Ilpo Järvinen, Derek J. Clark, Alperen Aksu
  Cc: Mark Pearson, platform-driver-x86, skhan, linux-kernel-mentees

Am 15.09.25 um 12:13 schrieb Ilpo Järvinen:

> On Wed, 20 Aug 2025, Derek J. Clark wrote:
>> On August 20, 2025 8:58:35 AM PDT, Alperen Aksu <aksulperen@gmail.com> wrote:
>>> Fix to correct spelling of "Hardware"
>>>
>> Hi Alperen,
>>
>> While we can fix the spelling of these, they are currently as provided by Lenovo. The spelling error exists in the WMI interfaces and during development we decided to leave them wrong to match.
> Yes, I'm not keen on accepting patches like this.
>
> These are hardly something user reads as documentation anyway.

I agree with Derek, this part of the documentation contains text extracted from the underlying interface description of the device.
While it is true that most WMI MOF descriptions contain spelling mistakes, correcting them just for the documentation serves no
purpose.

So thank you for you effort, but the spelling fix is misplaced here.

Thanks,
Armin Wolf

>> - Derek
>>
>>> Signed-off-by: Alperen Aksu <aksulperen@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..24b027362e93 100644
>>> --- a/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>> +++ b/Documentation/wmi/devices/lenovo-wmi-gamezone.rst
>>> @@ -126,7 +126,7 @@ data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility:
>>>      [WmiMethodId(65), Implemented, Description("Set IGPU Mode")] void SetIGPUModeStatus([in, Description("IGPU Mode")] UINT32 mode, [out, Description("return code")] UINT32 Data);
>>>      [WmiMethodId(66), Implemented, Description("Notify DGPU Status")] void NotifyDGPUStatus([in, Description("DGPU status")] UINT32 status, [out, Description("return code")] UINT32 Data);
>>>      [WmiMethodId(67), Implemented, Description("Is changed Y log")] void IsChangedYLog([out, Description("Is changed Y Log")] UINT32 Data);
>>> -    [WmiMethodId(68), Implemented, Description("Get DGPU Hardwawre ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
>>> +    [WmiMethodId(68), Implemented, Description("Get DGPU Hardware ID")] void GetDGPUHWId([out, Description("Get DGPU Hardware ID")] string Data);
>>>    };
>>>
>>>    [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), Description("Definition of CPU OC parameter list"), guid("{B7F3CA0A-ACDC-42D2-9217-77C6C628FBD2}")]
>> - Derek
>>

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-09-15 21:49 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-20 15:58 [PATCH] Documentation/wmi: Fix Typo Error in doc Alperen Aksu
2025-08-20 23:21 ` Derek J. Clark
2025-09-15 10:13   ` Ilpo Järvinen
2025-09-15 21:49     ` Armin Wolf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox