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

Message ID 20190329102219.17876-1-lukaszx.krakowiak@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] doc: updated json sample code for fifo interface
Related show

Checks

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

Commit Message

Lukasz Krakowiak March 29, 2019, 10:22 a.m.
Updated doc for JSON sample code related to vm_power_manager
fifo interface: "command": "destroy", "command": "power".
Corrected typo in doc vm_power_management.rst: 'json' instead
of 'jason'.

---
v2:
* coding style improved

Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
---
 doc/guides/sample_app_ug/vm_power_management.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

David Hunt April 15, 2019, 3:06 p.m. | #1
On 29/3/2019 10:22 AM, Lukasz Krakowiak wrote:
> Updated doc for JSON sample code related to vm_power_manager
> fifo interface: "command": "destroy", "command": "power".
> Corrected typo in doc vm_power_management.rst: 'json' instead
> of 'jason'.
>
> ---
> v2:
> * coding style improved
>
> Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
> ---
>   doc/guides/sample_app_ug/vm_power_management.rst | 7 ++++---
>   1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
> index 14d432e78..0182a92b3 100644
> --- a/doc/guides/sample_app_ug/vm_power_management.rst
> +++ b/doc/guides/sample_app_ug/vm_power_management.rst
> @@ -384,7 +384,7 @@ the file.
>   
>   The fifo is at /tmp/powermonitor/fifo
>   
> -The jason string can be a policy or instruction, and takes the following
> +The json string can be a policy or instruction, and takes the following
>   format:
>   
>     .. code-block:: javascript
> @@ -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
>       }}


Acked-by: David Hunt <david.hunt@intel.com>
Thomas Monjalon April 22, 2019, 10:30 p.m. | #2
29/03/2019 11:22, Lukasz Krakowiak:
> Updated doc for JSON sample code related to vm_power_manager
> fifo interface: "command": "destroy", "command": "power".
> Corrected typo in doc vm_power_management.rst: 'json' instead
> of 'jason'.
> 
> ---
> v2:
> * coding style improved
> 
> Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>

The SoB must be above the ---
Please add a line "Fixes:"
Thomas Monjalon May 9, 2019, 6:57 p.m. | #3
23/04/2019 00:30, Thomas Monjalon:
> 29/03/2019 11:22, Lukasz Krakowiak:
> > Updated doc for JSON sample code related to vm_power_manager
> > fifo interface: "command": "destroy", "command": "power".
> > Corrected typo in doc vm_power_management.rst: 'json' instead
> > of 'jason'.
> > 
> > ---
> > v2:
> > * coding style improved
> > 
> > Signed-off-by: Lukasz Krakowiak <lukaszx.krakowiak@intel.com>
> 
> The SoB must be above the ---
> Please add a line "Fixes:"

Why there is no update?

Patch

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 14d432e78..0182a92b3 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -384,7 +384,7 @@  the file.
 
 The fifo is at /tmp/powermonitor/fifo
 
-The jason string can be a policy or instruction, and takes the following
+The json string can be a policy or instruction, and takes the following
 format:
 
   .. code-block:: javascript
@@ -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
     }}