[dpdk-dev] [PATCH v1 6/7] doc/vm_power_manager: add JSON interface API info

[Hunt, David]

Hi Lei,


On 4/9/2018 6:17 AM, Yao, Lei A wrote:
>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of David Hunt
>> Sent: Thursday, August 30, 2018 6:54 PM
>> To: dev at dpdk.org
>> Cc: Mcnamara, John <john.mcnamara at intel.com>; Hunt, David
>> <david.hunt at intel.com>
>> Subject: [dpdk-dev] [PATCH v1 6/7] doc/vm_power_manager: add JSON
>> interface API info
>>
>> Signed-off-by: David Hunt <david.hunt at intel.com>
>> ---
>>   .../sample_app_ug/vm_power_management.rst     | 195
>> ++++++++++++++++++
>>   1 file changed, 195 insertions(+)
>>
>> diff --git a/doc/guides/sample_app_ug/vm_power_management.rst
>> b/doc/guides/sample_app_ug/vm_power_management.rst
>> index 855570d6b..13a325eae 100644
>> --- a/doc/guides/sample_app_ug/vm_power_management.rst
>> +++ b/doc/guides/sample_app_ug/vm_power_management.rst
>> @@ -337,6 +337,201 @@ monitoring of branch ratio on cores doing busy
>> polling via PMDs.
>>     and will need to be adjusted for different workloads.
>>
>>
>> +
>> +JSON API
>> +~~~~~~~~
>> +
--snip--
>> +:Pair Name: "quiet_hours"
>> +:Description: The hours of the day in which we scale down the cores for
>> quiet
>> +  times.
>> +:Type: array of integers
>> +:Values: array with list of hour numbers, (0-23)
>> +:Required: only for TIME policy
>> +:Example:
>> +
>> +  .. code-block:: console
>> +
>> +    "quiet_hours":[ 2, 3, 4, 5, 6 ]
>> +
> Do you think we need document following three key here?
> min_packet_thresh
> avg_packet_thresh
> max_packet_thresh
> I see them in the code but not documented.
>

Good catch. I missed these in the docs. Also I checked the code there 
these are
used, and only two are needed. These are avg and max.
Below, avg, the freq is set to minimum
Between avg and max, the freq us set to medium
Above max, the freq is set to maximum.

I'll remove the minimum from the code, seeing as it's not used, and 
document avg and max.

Rgds,
Dave.

--snip--