Commit c0698212 authored by Markus Armbruster's avatar Markus Armbruster
Browse files

qmp: Say "out-of-band" instead of "Out-Of-Band" 



Affects documentation and a few error messages.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <20180703085358.13941-2-armbru@redhat.com>
parent e8c85894

docs/devel/qapi-code-gen.txt

+1 −1
Original line number Diff line number Diff line
@@ -641,7 +641,7 @@ possible, the command expression should include the optional key 
'success-response' with boolean value false.  So far, only QGA makes

use of this member.



A command can be declared to support Out-Of-Band (OOB) execution.  By

A command can be declared to support out-of-band (OOB) execution.  By

default, commands do not support OOB.  To declare a command that

supports it, the schema includes an extra 'allow-oob' field.  For

example:

docs/interop/qmp-spec.txt

+1 −1
Original line number Diff line number Diff line
@@ -85,7 +85,7 @@ The greeting message format is: 


Currently supported capabilities are:



- "oob": the QMP server supports "Out-Of-Band" (OOB) command

- "oob": the QMP server supports "out-of-band" (OOB) command

  execution.  For more details, please see the "run-oob" parameter in

  the "Issuing Commands" section below.  Not all commands allow this

  "oob" execution.  The "query-qmp-schema" command can be used to

monitor.c

+7 −7
Original line number Diff line number Diff line
@@ -1268,11 +1268,11 @@ static void qmp_caps_check(Monitor *mon, QMPCapabilityList *list, 
        case QMP_CAPABILITY_OOB:

            if (!mon->use_io_thr) {

                /*

                 * Out-Of-Band only works with monitors that are

                 * Out-of-band only works with monitors that are

                 * running on dedicated IOThread.

                 */

                error_setg(errp, "This monitor does not support "

                           "Out-Of-Band (OOB)");

                           "out-of-band (OOB)");

                return;

            }

            break;
@@ -1320,7 +1320,7 @@ static bool qmp_cmd_oob_check(Monitor *mon, QDict *req, Error **errp) 


    if (qmp_is_oob(req)) {

        if (!qmp_oob_enabled(mon)) {

            error_setg(errp, "Please enable Out-Of-Band first "

            error_setg(errp, "Please enable out-of-band first "

                       "for the session during capabilities negotiation");

            return false;

        }
@@ -4294,7 +4294,7 @@ static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens) 


    /* When OOB is enabled, the "id" field is mandatory. */

    if (qmp_oob_enabled(mon) && !id) {

        error_setg(&err, "Out-Of-Band capability requires that "

        error_setg(&err, "Out-of-band capability requires that "

                   "every command contains an 'id' field");

        goto err;

    }
@@ -4308,7 +4308,7 @@ static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens) 
    qdict_del(qdict, "id");



    if (qmp_is_oob(qdict)) {

        /* Out-Of-Band (OOB) requests are executed directly in parser. */

        /* Out-of-band (OOB) requests are executed directly in parser. */

        trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(req_obj->id)

                                          ?: "");

        monitor_qmp_dispatch_one(req_obj);
@@ -4684,12 +4684,12 @@ void monitor_init(Chardev *chr, int flags) 


    if (use_oob) {

        if (CHARDEV_IS_MUX(chr)) {

            error_report("Monitor Out-Of-Band is not supported with "

            error_report("Monitor out-of-band is not supported with "

                         "MUX typed chardev backend");

            exit(1);

        }

        if (use_readline) {

            error_report("Monitor Out-Of-band is only supported by QMP");

            error_report("Monitor out-of-band is only supported by QMP");

            exit(1);

        }

    }

qapi/misc.json

+1 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ 
# Enumeration of capabilities to be advertised during initial client

# connection, used for agreeing on particular QMP extension behaviors.

#

# @oob:   QMP ability to support Out-Of-Band requests.

# @oob:   QMP ability to support out-of-band requests.

#         (Please refer to qmp-spec.txt for more information on OOB)

#

# Since: 2.12

tests/qapi-schema/qapi-schema-test.json

+1 −1
Original line number Diff line number Diff line
@@ -141,7 +141,7 @@ 
{ 'command': 'boxed-struct', 'boxed': true, 'data': 'UserDefZero' }

{ 'command': 'boxed-union', 'data': 'UserDefNativeListUnion', 'boxed': true }



# Smoke test on Out-Of-Band and allow-preconfig-test

# Smoke test on out-of-band and allow-preconfig-test

{ 'command': 'test-flags-command', 'allow-oob': true, 'allow-preconfig': true }



# For testing integer range flattening in opts-visitor. The following schema