diff mbox series

doc/power: add info on scale mode reaction time

Message ID 20211124165300.31165-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc/power: add info on scale mode reaction time |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS

Commit Message

Hunt, David Nov. 24, 2021, 4:53 p.m. UTC 
  When using PMD Power Management, scale mode reacts slower than
monitor mode and pause mode. Add note in user guide to this
effect.

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/prog_guide/power_man.rst               | 4 +++-
 doc/guides/sample_app_ug/l3_forward_power_man.rst | 5 +++--
 2 files changed, 6 insertions(+), 3 deletions(-)

Comments

Thomas Monjalon Nov. 26, 2021, 1:23 p.m. UTC | #1 
24/11/2021 17:53, David Hunt:
> When using PMD Power Management, scale mode reacts slower than
> monitor mode and pause mode. Add note in user guide to this
> effect.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>
> ---
>     This power saving scheme will use ``librte_power`` library functionality to
> -   scale the core frequency up/down depending on traffic volume.
> +   scale the core frequency up/down depending on traffic volume. The reaction
> +   time of the frequency scaling mode is longer than the pause and monitor
> +   mode.
[...]
> -  This will use frequency scaling routines
> -  available in the ``librte_power`` library.
> +  This will use frequency scaling routines available in
> +  the ``librte_power`` library. The reaction time of the
> +  scale mode is longer than the pause and monitor mode.

You don't have to change existing lines to add a new sentence.
That's why I recommend always starting a new sentence on a new line.
I fixed it to make the patch cleaner.

Applied
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index e387d7811e..66592cf22f 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -216,7 +216,9 @@  power saving whenever empty poll count reaches a certain number.
 
 * Frequency scaling
    This power saving scheme will use ``librte_power`` library functionality to
-   scale the core frequency up/down depending on traffic volume.
+   scale the core frequency up/down depending on traffic volume. The reaction
+   time of the frequency scaling mode is longer than the pause and monitor
+   mode.
 
 The "monitor" mode is only supported in the following configurations and scenarios:
 
diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index 8817eaadbf..84b014fab5 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -345,8 +345,9 @@  and has three available power management schemes:
   to avoid busy looping when there is no traffic.
 
 ``scale``
-  This will use frequency scaling routines
-  available in the ``librte_power`` library.
+  This will use frequency scaling routines available in
+  the ``librte_power`` library. The reaction time of the
+  scale mode is longer than the pause and monitor mode.
 
 See :doc:`Power Management<../prog_guide/power_man>` chapter
 in the DPDK Programmer's Guide for more details on PMD power management.