* [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone
@ 2025-08-17 17:06 rakuram
2025-08-20 14:37 ` Mark Pearson
0 siblings, 1 reply; 5+ messages in thread
From: rakuram @ 2025-08-17 17:06 UTC (permalink / raw)
To: linux-doc
Cc: mpearson-lenovo, derekjohn.clark, W_Armin, corbet,
platform-driver-x86, linux-kernel-mentees, skhan, rakuram.e96
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone
2025-08-17 17:06 [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone rakuram
@ 2025-08-20 14:37 ` Mark Pearson
2025-09-15 10:32 ` Ilpo Järvinen
0 siblings, 1 reply; 5+ messages in thread
From: Mark Pearson @ 2025-08-20 14:37 UTC (permalink / raw)
To: rakuram, linux-doc
Cc: Derek J . Clark, Armin Wolf, Jonathan Corbet,
platform-driver-x86@vger.kernel.org, linux-kernel-mentees, skhan
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>
Mark
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone
2025-08-20 14:37 ` Mark Pearson
@ 2025-09-15 10:32 ` Ilpo Järvinen
2025-09-15 18:23 ` Mark Pearson
0 siblings, 1 reply; 5+ messages in thread
From: Ilpo Järvinen @ 2025-09-15 10:32 UTC (permalink / raw)
To: Mark Pearson
Cc: rakuram, linux-doc, Derek J . Clark, Armin Wolf, Jonathan Corbet,
platform-driver-x86@vger.kernel.org, linux-kernel-mentees, skhan
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone
2025-09-15 10:32 ` Ilpo Järvinen
@ 2025-09-15 18:23 ` Mark Pearson
2025-09-15 21:54 ` Armin Wolf
0 siblings, 1 reply; 5+ messages in thread
From: Mark Pearson @ 2025-09-15 18:23 UTC (permalink / raw)
To: Ilpo Järvinen
Cc: rakuram, linux-doc, Derek J . Clark, Armin Wolf, Jonathan Corbet,
platform-driver-x86@vger.kernel.org, linux-kernel-mentees, skhan
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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone
2025-09-15 18:23 ` Mark Pearson
@ 2025-09-15 21:54 ` Armin Wolf
0 siblings, 0 replies; 5+ messages in thread
From: Armin Wolf @ 2025-09-15 21:54 UTC (permalink / raw)
To: Mark Pearson, Ilpo Järvinen
Cc: rakuram, linux-doc, Derek J . Clark, Jonathan Corbet,
platform-driver-x86@vger.kernel.org, linux-kernel-mentees, skhan
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
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2025-09-15 21:59 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-17 17:06 [PATCH] Documentation/wmi: Fix Typo in lenovo-wmi-gamezone rakuram
2025-08-20 14:37 ` Mark Pearson
2025-09-15 10:32 ` Ilpo Järvinen
2025-09-15 18:23 ` Mark Pearson
2025-09-15 21:54 ` Armin Wolf
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox