[v4] doc: updated json sample code for fifo interface

Message ID 20190513141355.8208-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Headers
Series [v4] doc: updated json sample code for fifo interface |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Hunt, David May 13, 2019, 2:13 p.m. UTC
  From: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>

Updated doc for JSON sample code related to vm_power_manager
fifo interface: "command": "destroy", "command": "power".

There is no code change to go with this doc update, it is to fix
the docs to match the implementation in the code.

Fixes: a63504a90f ("examples/power: add JSON string handling")
Cc: stable@dpdk.org
Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
Acked-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/sample_app_ug/vm_power_management.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
  

Comments

Thomas Monjalon May 13, 2019, 4:57 p.m. UTC | #1
13/05/2019 16:13, David Hunt:
> From: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
> 
> Updated doc for JSON sample code related to vm_power_manager
> fifo interface: "command": "destroy", "command": "power".
> 
> There is no code change to go with this doc update, it is to fix
> the docs to match the implementation in the code.
> 
> Fixes: a63504a90f ("examples/power: add JSON string handling")
> Cc: stable@dpdk.org
> Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
> Acked-by: David Hunt <david.hunt@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 109d10957..5d9a26172 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -597,7 +597,7 @@  Profile destroy example:
 
   .. code-block:: javascript
 
-    {"profile": {
+    {"policy": {
       "name": "ubuntu",
       "command": "destroy",
     }}
@@ -606,8 +606,9 @@  Power command example:
 
   .. code-block:: javascript
 
-    {"command": {
+    {"instruction": {
       "name": "ubuntu",
+      "command": "power",
       "unit": "SCALE_MAX",
       "resource_id": 10
     }}