From patchwork Fri Sep 25 14:03:35 2015 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: 522818 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 49041140775 for ; Sat, 26 Sep 2015 00:09:37 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=D3xb4eMz; dkim-atps=neutral Received: from localhost ([::1]:41988 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTgs-0007CL-Rc for incoming@patchwork.ozlabs.org; Fri, 25 Sep 2015 10:09:34 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41543) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTbp-0006Ry-W1 for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:23 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZfTbl-0003Mc-3Y for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:21 -0400 Received: from mail-wi0-x22d.google.com ([2a00:1450:400c:c05::22d]:34384) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfTbk-0003LR-QU for qemu-devel@nongnu.org; Fri, 25 Sep 2015 10:04:17 -0400 Received: by wicfx3 with SMTP id fx3so23376136wic.1 for ; Fri, 25 Sep 2015 07:04:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-type:content-transfer-encoding; bh=NVUREHPNbyuoGWyDeJ0TznZJpZ++P3RsgcKeXiqQ/20=; b=D3xb4eMz/+MUuKOTrZz/NV2g0wBcW/OADtHISzF5SFH1SRyW58bpoU++PkWCV6Y1tr uhPnlI1xcaFez5U1rc9QbAc1I2XZ/nwBpBgHJlHK67CiXWC8lnPO9YupMRVoXytFHQZj O/bXg8nG/yKHEI4jvfLAaFqqcB9YkdtEjR0p5AxQkR5GZNwo832Mc+VFzp9WQJpc4ER+ zk/gxFOf92lhcG41LdrOzp+58iip2h4IkrDTP6PLQfaN2/48Bglv8yzgIB/f8kSsmfGA Hwx81plpxurnOmA/FBHBD2h9LhbTNA6l9pIgVxRY+n9pJLnV3svQYnhz7vGXFC0d8gX7 X2Zg== X-Received: by 10.194.79.196 with SMTP id l4mr7086545wjx.93.1443189856200; Fri, 25 Sep 2015 07:04:16 -0700 (PDT) Received: from localhost ([149.6.167.210]) by smtp.gmail.com with ESMTPSA id bu19sm3495200wjb.45.2015.09.25.07.04.15 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 25 Sep 2015 07:04:15 -0700 (PDT) From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Date: Fri, 25 Sep 2015 16:03:35 +0200 Message-Id: <1443189844-20341-8-git-send-email-marcandre.lureau@redhat.com> X-Mailer: git-send-email 2.4.3 In-Reply-To: <1443189844-20341-1-git-send-email-marcandre.lureau@redhat.com> References: <1443189844-20341-1-git-send-email-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::22d Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , armbru@redhat.com, mdroth@linux.vnet.ibm.com Subject: [Qemu-devel] [PATCH 07/36] qapi: add some headings in docs X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: Marc-André Lureau Add some missing double-#, the doc parser can't easily distinguish doc comments from comments to be ignored otherwise. Also add some more section headings. Signed-off-by: Marc-André Lureau Reviewed-by: Eric Blake --- qapi-schema.json | 12 ++++++++++-- qapi/block-core.json | 6 ++++-- qapi/block.json | 5 +++-- qapi/common.json | 5 +++-- qapi/event.json | 5 +++++ qapi/rocker.json | 3 +++ qapi/trace.json | 2 ++ qga/qapi-schema.json | 2 ++ 8 files changed, 32 insertions(+), 8 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index c8ee75d..b01de49 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -67,6 +67,9 @@ { 'include': 'qapi/introspect.json' } ## +# = QMP commands + +## # @qmp_capabilities: # # Enable QMP capabilities. @@ -107,6 +110,7 @@ { 'enum': 'LostTickPolicy', 'data': ['discard', 'delay', 'merge', 'slew' ] } +## # @add_client # # Allow client connections for VNC, Spice and socket based @@ -590,6 +594,7 @@ 'cache-miss': 'int', 'cache-miss-rate': 'number', 'overflow': 'int' } } +## # @MigrationStatus: # # An enumeration of migration status. @@ -880,6 +885,7 @@ ## { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']} +## # @MigrationParameter # # Migration parameters enumeration @@ -903,7 +909,7 @@ { 'enum': 'MigrationParameter', 'data': ['compress-level', 'compress-threads', 'decompress-threads'] } -# +## # @migrate-set-parameters # # Set the following migration parameters @@ -927,7 +933,7 @@ '*compress-threads': 'int', '*decompress-threads': 'int'} } -# +## # @MigrationParameters # # @compress-level: compression level @@ -2748,6 +2754,7 @@ ## { 'command': 'migrate-incoming', 'data': {'uri': 'str' } } +## # @xen-save-devices-state: # # Save the state of all devices to file. The RAM and the block devices @@ -3639,6 +3646,7 @@ ## { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] } +## # @AddfdInfo: # # Information about a file descriptor that was added to an fd set. diff --git a/qapi/block-core.json b/qapi/block-core.json index d5b6ed1..ff2d4a6 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1,6 +1,7 @@ # -*- Mode: Python -*- -# -# QAPI block core definitions (vm unrelated) + +## +# == QAPI block core definitions (vm unrelated) # QAPI common definitions { 'include': 'common.json' } @@ -2440,6 +2441,7 @@ 'offset': 'int', 'speed' : 'int' } } +## # @PreallocMode # # Preallocation mode of QEMU image file diff --git a/qapi/block.json b/qapi/block.json index 9902b94..487abb2 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -1,6 +1,7 @@ # -*- Mode: Python -*- -# -# QAPI block definitions (vm related) + +## +# = QAPI block definitions (vm related) # QAPI block core definitions { 'include': 'block-core.json' } diff --git a/qapi/common.json b/qapi/common.json index 4e94c89..0972f4a 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -1,6 +1,7 @@ # -*- Mode: Python -*- -# -# QAPI common definitions + +## +# = QAPI common definitions ## # @ErrorClass diff --git a/qapi/event.json b/qapi/event.json index f0cef01..ce5853d 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -1,3 +1,8 @@ +# -*- Mode: Python -*- + +## +# = Events + ## # @SHUTDOWN # diff --git a/qapi/rocker.json b/qapi/rocker.json index 7cfccc4..fe17d36 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -1,4 +1,7 @@ ## +# = Rocker API + +## # @Rocker: # # Rocker switch information. diff --git a/qapi/trace.json b/qapi/trace.json index 5111640..4faa6d3 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -5,6 +5,8 @@ # 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: diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 82894c6..c138a41 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -808,6 +808,7 @@ { 'command': 'guest-set-user-password', 'data': { 'username': 'str', 'password': 'str', 'crypted': 'bool' } } +## # @GuestMemoryBlock: # # @phys-index: Arbitrary guest-specific unique identifier of the MEMORY BLOCK. @@ -907,6 +908,7 @@ 'data': {'mem-blks': ['GuestMemoryBlock'] }, 'returns': ['GuestMemoryBlockResponse'] } +## # @GuestMemoryBlockInfo: # # @size: the size (in bytes) of the guest memory blocks,