[v3,11/14] qapi: fix example of MEMORY_FAILURE

Commit Message

Victor Toso March 28, 2022, 2:06 p.m. UTC

Example output lacks mandatory member @timestamp.  Provide it.

While @flags is an optional member, if it is defined then all its
members should be include. For that reason, we add @recursive member.

Minor: Change quotes from '' to "" in @action-required member.

Signed-off-by: Victor Toso <[e-mail]>
Reviewed-by: John Snow <[e-mail]>
---
 qapi/run-state.json | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Markus Armbruster March 29, 2022, 3:52 p.m. UTC | #1

Victor Toso <[e-mail]> writes:

> Example output lacks mandatory member @timestamp.  Provide it.
>
> While @flags is an optional member,

Uh, it isn't.

>                                     if it is defined then all its
> members should be include. For that reason, we add @recursive member.

Perhaps:

  Example output lacks mandatory member flags.recursive.  Provide it.

Happy to make such a change in my tree.

> Minor: Change quotes from '' to "" in @action-required member.
>
> Signed-off-by: Victor Toso <[e-mail]>
> Reviewed-by: John Snow <[e-mail]>
> ---
>  qapi/run-state.json | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index 7f1c788c4e..8124220bd9 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json
> @@ -571,7 +571,9 @@
>  # <- { "event": "MEMORY_FAILURE",
>  #      "data": { "recipient": "hypervisor",
>  #                "action": "fatal",
> -#                "flags": { 'action-required': false } }
> +#                "flags": { "action-required": false,
> +#                           "recursive": false } },
> +#      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
>  #
>  ##
>  { 'event': 'MEMORY_FAILURE',

With the commit message fixed:
Reviewed-by: Markus Armbruster <[e-mail]>

Victor Toso March 30, 2022, 10:15 a.m. UTC | #2

Hi,

On Tue, Mar 29, 2022 at 05:52:47PM +0200, Markus Armbruster wrote:
> Victor Toso <[e-mail]> writes:
> 
> > Example output lacks mandatory member @timestamp.  Provide it.
> >
> > While @flags is an optional member,
> 
> Uh, it isn't.

Wow! I was so sure I saw "*flags" before. Nice catch.

> >                                     if it is defined then all its
> > members should be include. For that reason, we add @recursive member.
> 
> Perhaps:
> 
>   Example output lacks mandatory member flags.recursive.  Provide it.
> 
> Happy to make such a change in my tree.

Yes, many thanks!

> > Minor: Change quotes from '' to "" in @action-required member.
> >
> > Signed-off-by: Victor Toso <[e-mail]>
> > Reviewed-by: John Snow <[e-mail]>
> > ---
> >  qapi/run-state.json | 4 +++-
> >  1 file changed, 3 insertions(+), 1 deletion(-)
> >
> > diff --git a/qapi/run-state.json b/qapi/run-state.json
> > index 7f1c788c4e..8124220bd9 100644
> > --- a/qapi/run-state.json
> > +++ b/qapi/run-state.json
> > @@ -571,7 +571,9 @@
> >  # <- { "event": "MEMORY_FAILURE",
> >  #      "data": { "recipient": "hypervisor",
> >  #                "action": "fatal",
> > -#                "flags": { 'action-required': false } }
> > +#                "flags": { "action-required": false,
> > +#                           "recursive": false } },
> > +#      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
> >  #
> >  ##
> >  { 'event': 'MEMORY_FAILURE',
> 
> With the commit message fixed:
> Reviewed-by: Markus Armbruster <[e-mail]>

Cheers,
Victor

Patch

diff --git a/qapi/run-state.json b/qapi/run-state.json
index 7f1c788c4e..8124220bd9 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -571,7 +571,9 @@ 
 # <- { "event": "MEMORY_FAILURE",
 #      "data": { "recipient": "hypervisor",
 #                "action": "fatal",
-#                "flags": { 'action-required': false } }
+#                "flags": { "action-required": false,
+#                           "recursive": false } },
+#      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 #
 ##
 { 'event': 'MEMORY_FAILURE',