From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:37063) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dhHLY-0002rR-K8 for qemu-devel@nongnu.org; Mon, 14 Aug 2017 11:32:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dhHLV-0006oZ-87 for qemu-devel@nongnu.org; Mon, 14 Aug 2017 11:32:04 -0400 Received: from mx1.redhat.com ([209.132.183.28]:51310) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dhHLU-0006o7-Va for qemu-devel@nongnu.org; Mon, 14 Aug 2017 11:32:01 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id BD1B54023A for ; Mon, 14 Aug 2017 15:31:59 +0000 (UTC) From: Markus Armbruster References: <20170808205327.8768-1-crosa@redhat.com> <20170808205327.8768-2-crosa@redhat.com> <2e9697af-a48f-9fb6-696f-c2a8d3aebb06@redhat.com> Date: Mon, 14 Aug 2017 17:31:52 +0200 In-Reply-To: (Cleber Rosa's message of "Tue, 8 Aug 2017 17:26:02 -0400") Message-ID: <87poby413r.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Qemu-devel] [PATCH 1/1] QAPI schema: turn example commands/returns into proper JSON List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Cleber Rosa Cc: Eric Blake , qemu-devel@nongnu.org Cleber Rosa writes: > On 08/08/2017 05:13 PM, Eric Blake wrote: >> On 08/08/2017 03:53 PM, Cleber Rosa wrote: >>> Most QMP commands and returns in the QAPI schema documentation >>> are valid "JSON-based wire format". A few examples are either >>> malformed, or contain comments. >>> >>> This fixes all the examples command and return data, making them >>> proper JSON, as they would be received and generated by QEMU's >>> QMP monitor. >>> >>> Signed-off-by: Cleber Rosa >>> --- >>> qapi-schema.json | 9 ++++----- >>> qapi/block-core.json | 32 ++++++++++++++++---------------- >>> qapi/rocker.json | 5 +---- >>> 3 files changed, 21 insertions(+), 25 deletions(-) >> >> >>> +++ b/qapi-schema.json >>> @@ -2000,8 +2000,7 @@ >>> # "host": "127.0.0.1", >>> # "channel-id": 0, >>> # "tls": false >>> -# }, >>> -# [ ... more channels follow ... ] >>> +# } >> >> I still wonder if we want SOME sort of markup to make it obvious where >> we are compressing the example for the sake of brevity, where whatever >> we use to automate tests based on the docs would know how to recognize >> that the actual values given in reply to the test can be longer than the >> documented example. But I guess we can cross that when we have an >> automated test where it matters. >> > > I wonder the same. Also, we seem to agree that it's a separate and more > complex problem, to be tackled later. We can cross that bridge when we get to it. Any particular reason not to keep the [ ... more channels follow ... ] until then? >>> @@ -2039,7 +2038,7 @@ >>> # >>> # -> { "execute": "query-balloon" } >>> # <- { "return": { >>> -# "actual": 1073741824, >>> +# "actual": 1073741824 >>> # } This is a straighforward doc fix. >> I also suspect that test automation will have to do a lot of filtering, >> even for commands that don't need to be abbreviated, since some of the >> examples have pretty arbitrary numbers that will be difficult to >> reliably reproduce any particular number. >> > > Yes. I'm already aware of a couple of use cases that will require > different types of comparison, including pretty relaxed ones. Expect > more about that in a later thread. > >> This is a documentation fix, so it could still go in 2.10 - but since we >> are past -rc2, it's probably just as easy to save it for 2.11. Either way, >> >> Reviewed-by: Eric Blake >> > > Thanks for the prompt review!