| Message ID | 20240227113921.236097-9-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | Subject: [PATCH 00/15] qapi: Improve command response documentation | expand |
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com> On Tue, Feb 27, 2024 at 1:39 PM Markus Armbruster <armbru@redhat.com> wrote: > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > qga/qapi-schema.json | 22 ++++++++++------------ > 1 file changed, 10 insertions(+), 12 deletions(-) > > diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json > index b8efe31897..c5f2ac8f59 100644 > --- a/qga/qapi-schema.json > +++ b/qga/qapi-schema.json > @@ -561,9 +561,8 @@ > # could also exit (or set its status to "shutdown") due to other > # reasons. > # > -# The following errors may be returned: > -# > -# - If suspend to disk is not supported, Unsupported > +# Errors: > +# - If suspend to disk is not supported, Unsupported > # > # Notes: It's strongly recommended to issue the guest-sync command > # before sending commands when the guest resumes > @@ -598,9 +597,8 @@ > # 2. Issue the query-status QMP command to confirm the VM status is > # "suspended" > # > -# The following errors may be returned: > -# > -# - If suspend to ram is not supported, Unsupported > +# Errors: > +# - If suspend to ram is not supported, Unsupported > # > # Notes: It's strongly recommended to issue the guest-sync command > # before sending commands when the guest resumes > @@ -634,9 +632,8 @@ > # 2. Issue the query-status QMP command to confirm the VM status is > # "suspended" > # > -# The following errors may be returned: > -# > -# - If hybrid suspend is not supported, Unsupported > +# Errors: > +# - If hybrid suspend is not supported, Unsupported > # > # Notes: It's strongly recommended to issue the guest-sync command > # before sending commands when the guest resumes > @@ -796,9 +793,6 @@ > # - 0: > # if the @vcpus list was empty on input. Guest state has not > # been changed. Otherwise, > -# - Error: > -# processing the first node of @vcpus failed for the reason > -# returned. Guest state has not been changed. Otherwise, > # - < length(@vcpus): > # more than zero initial nodes have been processed, but not the > # entire @vcpus list. Guest state has changed accordingly. To > @@ -808,6 +802,10 @@ > # - length(@vcpus): > # call successful. > # > +# Errors: > +# - If the reconfiguration of the first node in @vcpus failed. > +# Guest state has not been changed. > +# > # Since: 1.5 > ## > { 'command': 'guest-set-vcpus', > -- > 2.43.0 > >
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index b8efe31897..c5f2ac8f59 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -561,9 +561,8 @@ # could also exit (or set its status to "shutdown") due to other # reasons. # -# The following errors may be returned: -# -# - If suspend to disk is not supported, Unsupported +# Errors: +# - If suspend to disk is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -598,9 +597,8 @@ # 2. Issue the query-status QMP command to confirm the VM status is # "suspended" # -# The following errors may be returned: -# -# - If suspend to ram is not supported, Unsupported +# Errors: +# - If suspend to ram is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -634,9 +632,8 @@ # 2. Issue the query-status QMP command to confirm the VM status is # "suspended" # -# The following errors may be returned: -# -# - If hybrid suspend is not supported, Unsupported +# Errors: +# - If hybrid suspend is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -796,9 +793,6 @@ # - 0: # if the @vcpus list was empty on input. Guest state has not # been changed. Otherwise, -# - Error: -# processing the first node of @vcpus failed for the reason -# returned. Guest state has not been changed. Otherwise, # - < length(@vcpus): # more than zero initial nodes have been processed, but not the # entire @vcpus list. Guest state has changed accordingly. To @@ -808,6 +802,10 @@ # - length(@vcpus): # call successful. # +# Errors: +# - If the reconfiguration of the first node in @vcpus failed. +# Guest state has not been changed. +# # Since: 1.5 ## { 'command': 'guest-set-vcpus',
Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qga/qapi-schema.json | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-)