From patchwork Wed May 15 07:59:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Max Reitz X-Patchwork-Id: 1099882 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=redhat.com Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 453n6C6MQzz9s9N for ; Wed, 15 May 2019 18:00:17 +1000 (AEST) Received: from localhost ([127.0.0.1]:33050 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hQopi-00053c-I8 for incoming@patchwork.ozlabs.org; Wed, 15 May 2019 04:00:14 -0400 Received: from eggs.gnu.org ([209.51.188.92]:33933) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hQoou-00051h-BU for qemu-devel@nongnu.org; Wed, 15 May 2019 03:59:25 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hQoot-0004RH-Fa for qemu-devel@nongnu.org; Wed, 15 May 2019 03:59:24 -0400 Received: from mx1.redhat.com ([209.132.183.28]:35680) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hQoor-0004Iu-G4; Wed, 15 May 2019 03:59:21 -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 E43D1307EA93; Wed, 15 May 2019 07:59:19 +0000 (UTC) Received: from localhost (ovpn-204-29.brq.redhat.com [10.40.204.29]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 7CB535D9C2; Wed, 15 May 2019 07:59:19 +0000 (UTC) From: Max Reitz To: qemu-block@nongnu.org Date: Wed, 15 May 2019 09:59:15 +0200 Message-Id: <20190515075917.24980-1-mreitz@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.44]); Wed, 15 May 2019 07:59:20 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] =?utf-8?q?=5BPATCH_0/2=5D_qemu-img=2Etexi=3A_Provide?= =?utf-8?q?_more_info_on_some_commands=E2=80=99_output?= X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , qemu-devel@nongnu.org, Max Reitz Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" Most qemu-img subcommands that have (optional) JSON output don’t describe the structure of their JSON output -- but having a fixed, well-known output structure kind of is the point of having JSON output at all. Therefore, patch 1 in this series makes every such command note which QAPI type their JSON output has in the qemu-img man page. (The exception to this is the map subcommand, which does not emit a QAPI-typed object. It already has a description of the structure of its output object, though.) That should be enough to thoroughly explain the machine-readable output. But we can also do better for the human-readable output: qemu-img info emits quite a bit of information, and not all of it is self-explanatory. In patch 2, I’ve tried to provide some potentially missing explanation. Max Reitz (2): qemu-img.texi: Be specific about JSON object types qemu-img.texi: Describe human-readable info output qemu-img.texi | 52 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 49 insertions(+), 3 deletions(-)