From patchwork Tue Dec 6 14:13:30 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Marc-Andr=C3=A9_Lureau?= X-Patchwork-Id: 703168 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3tY3Z05Smnz9vrZ for ; Wed, 7 Dec 2016 01:15:36 +1100 (AEDT) Received: from localhost ([::1]:60272 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cEGWs-00051l-L7 for incoming@patchwork.ozlabs.org; Tue, 06 Dec 2016 09:15:34 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:44433) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cEGVQ-0003SV-TR for qemu-devel@nongnu.org; Tue, 06 Dec 2016 09:14:08 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cEGVP-00062l-MB for qemu-devel@nongnu.org; Tue, 06 Dec 2016 09:14:04 -0500 Received: from mx1.redhat.com ([209.132.183.28]:42700) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cEGVP-00062h-ER for qemu-devel@nongnu.org; Tue, 06 Dec 2016 09:14:03 -0500 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id A737AC04D28B for ; Tue, 6 Dec 2016 14:14:02 +0000 (UTC) Received: from localhost (ovpn-116-122.phx2.redhat.com [10.3.116.122]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id uB6EE0RH006551; Tue, 6 Dec 2016 09:14:01 -0500 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Date: Tue, 6 Dec 2016 17:13:30 +0300 Message-Id: <20161206141343.28044-5-marcandre.lureau@redhat.com> In-Reply-To: <20161206141343.28044-1-marcandre.lureau@redhat.com> References: <20161206141343.28044-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Tue, 06 Dec 2016 14:14:02 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v6 04/17] qapi: add some sections in docs 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: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , armbru@redhat.com Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" Add some more section titles to organize the documentation we're going to generate. Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster --- qapi-schema.json | 4 ++++ qapi/block-core.json | 6 ++++-- qapi/block.json | 10 ++++++++-- qapi/common.json | 6 ++++-- qapi/crypto.json | 5 ++++- qapi/event.json | 6 ++++++ qapi/rocker.json | 4 ++++ qapi/trace.json | 3 +++ 8 files changed, 37 insertions(+), 7 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index e29d47ded3..fbea3b18d9 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -20,6 +20,10 @@ # QAPI introspection { 'include': 'qapi/introspect.json' } +## +# = QMP commands +## + ## # @qmp_capabilities: # diff --git a/qapi/block-core.json b/qapi/block-core.json index ec1da2a29a..05cedc3f23 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1,6 +1,8 @@ # -*- Mode: Python -*- -# -# QAPI block core definitions (vm unrelated) + +## +# == QAPI block core definitions (vm unrelated) +## # QAPI common definitions { 'include': 'common.json' } diff --git a/qapi/block.json b/qapi/block.json index 937df05830..e4ad74bcb2 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -1,10 +1,16 @@ # -*- Mode: Python -*- -# -# QAPI block definitions (vm related) + +## +# = QAPI block definitions +## # QAPI block core definitions { 'include': 'block-core.json' } +## +# == QAPI block definitions (vm unrelated) +## + ## # @BiosAtaTranslation: # diff --git a/qapi/common.json b/qapi/common.json index 624a8619c8..d93f159946 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -1,6 +1,8 @@ # -*- Mode: Python -*- -# -# QAPI common definitions + +## +# = QAPI common definitions +## ## # @QapiErrorClass: diff --git a/qapi/crypto.json b/qapi/crypto.json index 15d296e3c1..1e517b0841 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -1,6 +1,9 @@ # -*- Mode: Python -*- # -# QAPI crypto definitions + +## +# = QAPI crypto definitions +## ## # @QCryptoTLSCredsEndpoint: diff --git a/qapi/event.json b/qapi/event.json index 37bf34ed6d..683666848a 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -1,3 +1,9 @@ +# -*- Mode: Python -*- + +## +# = Other events +## + ## # @SHUTDOWN: # diff --git a/qapi/rocker.json b/qapi/rocker.json index ace27760f1..1e511cd37a 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -1,3 +1,7 @@ +## +# = Rocker switch device +## + ## # @RockerSwitch: # diff --git a/qapi/trace.json b/qapi/trace.json index 4fd39b7792..3ad7df7fdb 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -5,6 +5,9 @@ # This work is licensed under the terms of the GNU GPL, version 2 or later. # See the COPYING file in the top-level directory. +## +# = Tracing commands +## ## # @TraceEventState: