[v2] power: fix a typo in the PM QoS guide

Message ID 20241112083537.19734-1-lihuisong@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] power: fix a typo in the PM QoS guide |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing warning Testing issues
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

lihuisong (C) Nov. 12, 2024, 8:35 a.m. UTC
The typo in the guide is hard to understand. Necessary to fix it.

Fixes: dd6fd75bf662 ("power: introduce PM QoS API on CPU wide")

Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
 doc/guides/prog_guide/power_man.rst | 2 +-
 lib/power/rte_power_qos.h           | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
  

Comments

Thomas Monjalon Nov. 12, 2024, 12:55 p.m. UTC | #1
12/11/2024 09:35, Huisong Li:
> The typo in the guide is hard to understand. Necessary to fix it.
> 
> Fixes: dd6fd75bf662 ("power: introduce PM QoS API on CPU wide")
> 
> Signed-off-by: Huisong Li <lihuisong@huawei.com>
> ---
> --- a/doc/guides/prog_guide/power_man.rst
> +++ b/doc/guides/prog_guide/power_man.rst
> -Some services are latency sensitive and very except the low resume time,
> +Some services are latency sensitive and request a low resume time,
>  like interrupt packet receiving mode.
[...]
> --- a/lib/power/rte_power_qos.h
> +++ b/lib/power/rte_power_qos.h
>   * The deeper the idle state, the lower the power consumption, but the
> - * longer the resume time. Some service are delay sensitive and very except the
> + * longer the resume time. Some service are delay sensitive and request a
>   * low resume time, like interrupt packet receiving mode.

Why not the same as above? "Some services are latency sensitive"
  
lihuisong (C) Nov. 13, 2024, 1:03 a.m. UTC | #2
在 2024/11/12 20:55, Thomas Monjalon 写道:
> 12/11/2024 09:35, Huisong Li:
>> The typo in the guide is hard to understand. Necessary to fix it.
>>
>> Fixes: dd6fd75bf662 ("power: introduce PM QoS API on CPU wide")
>>
>> Signed-off-by: Huisong Li <lihuisong@huawei.com>
>> ---
>> --- a/doc/guides/prog_guide/power_man.rst
>> +++ b/doc/guides/prog_guide/power_man.rst
>> -Some services are latency sensitive and very except the low resume time,
>> +Some services are latency sensitive and request a low resume time,
>>   like interrupt packet receiving mode.
> [...]
>> --- a/lib/power/rte_power_qos.h
>> +++ b/lib/power/rte_power_qos.h
>>    * The deeper the idle state, the lower the power consumption, but the
>> - * longer the resume time. Some service are delay sensitive and very except the
>> + * longer the resume time. Some service are delay sensitive and request a
>>    * low resume time, like interrupt packet receiving mode.
> Why not the same as above? "Some services are latency sensitive"
will fix it in next version.
>
>
>
>
> .
  

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index 22e6e4fe1d..74039e5786 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -118,7 +118,7 @@  based on this CPU resume latency in their idle task.
 
 The deeper the idle state, the lower the power consumption,
 but the longer the resume time.
-Some services are latency sensitive and very except the low resume time,
+Some services are latency sensitive and request a low resume time,
 like interrupt packet receiving mode.
 
 Applications can set and get the CPU resume latency with
diff --git a/lib/power/rte_power_qos.h b/lib/power/rte_power_qos.h
index 7a8dab9272..ce0c6eda15 100644
--- a/lib/power/rte_power_qos.h
+++ b/lib/power/rte_power_qos.h
@@ -24,7 +24,7 @@  extern "C" {
  * https://www.kernel.org/doc/html/latest/admin-guide/abi-testing.html?highlight=pm_qos_resume_latency_us#abi-sys-devices-power-pm-qos-resume-latency-us
  *
  * The deeper the idle state, the lower the power consumption, but the
- * longer the resume time. Some service are delay sensitive and very except the
+ * longer the resume time. Some service are delay sensitive and request a
  * low resume time, like interrupt packet receiving mode.
  *
  * In these case, per-CPU PM QoS API can be used to control this CPU's idle