[v4,3/3] doc: update vm_power_manager cmdline options in doc
diff mbox series

Message ID 20200714160200.1727417-3-rory.sexton@intel.com
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • [v4,1/3] examples/vm_power_manager: Make branch ratio threshold per core
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed
ci/checkpatch success coding style OK

Commit Message

Rory Sexton July 14, 2020, 4:02 p.m. UTC
Updating the vm_power_manager docs to reflect changes made in
previous patches in set.

Signed-off-by: Rory Sexton <rory.sexton@intel.com>
Reviewed-by: David Hunt <david.hunt@intel.com>

---
v4: no changes
---
 doc/guides/sample_app_ug/vm_power_management.rst | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

Comments

Reshma Pattan July 15, 2020, 3:15 p.m. UTC | #1
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Rory Sexton
> Signed-off-by: Rory Sexton <rory.sexton@intel.com>
> Reviewed-by: David Hunt <david.hunt@intel.com>
> 
> ---
> v4: no changes
> ---

Acked-by: Reshma Pattan <reshma.pattan@intel.com>
Thomas Monjalon July 17, 2020, 12:31 p.m. UTC | #2
14/07/2020 18:02, Rory Sexton:
> Updating the vm_power_manager docs to reflect changes made in
> previous patches in set.

For info, the doc must be updated atomically with the code.

Patch
diff mbox series

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index e98277ccb..1b6de8e93 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -410,19 +410,21 @@  There are a couple of command line parameters for enabling the out-of-band
 monitoring of branch ratios on cores doing busy polling using PMDs as
 described below:
 
-``--core-list {list of cores}``
+``--core-branch-ratio {list of cores}:{branch ratio for listed cores}``
    Specify the list of cores to monitor the ratio of branch misses
    to branch hits.  A tightly-polling PMD thread has a very low
    branch ratio, therefore the core frequency scales down to the
    minimum allowed value. On receiving packets, the code path changes,
    causing the branch ratio to increase. When the ratio goes above
    the ratio threshold, the core frequency scales up to the maximum
-   allowed value.
-
-``--branch-ratio {ratio}``
-   Specify a floating-point number that identifies the threshold at which
-   to scale up or down for the given workload. The default branch ratio
-   is 0.01 and needs adjustment for different workloads.
+   allowed value. The specified branch-ratio is a floating point number
+   that identifies the threshold at which to scale up or down for the
+   elements of the core-list. If not included the default branch ratio of
+   0.01 but will need adjustment for different workloads
+
+   This parameter can be used multiple times for different sets of cores.
+   The branch ratio mechanism can also be useful for non-PMD cores and
+   hyper-threaded environments where C-States are disabled.
 
 
 Compiling and Running the Guest Applications