From patchwork Fri Aug 20 19:42:31 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Capitulino X-Patchwork-Id: 62310 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 80BFEB70E1 for ; Sat, 21 Aug 2010 05:45:32 +1000 (EST) Received: from localhost ([127.0.0.1]:60084 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OmXWo-0002xj-7j for incoming@patchwork.ozlabs.org; Fri, 20 Aug 2010 15:45:26 -0400 Received: from [140.186.70.92] (port=38785 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OmXUV-0002D7-Vw for qemu-devel@nongnu.org; Fri, 20 Aug 2010 15:43:06 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OmXUG-0007vX-Hl for qemu-devel@nongnu.org; Fri, 20 Aug 2010 15:42:49 -0400 Received: from mx1.redhat.com ([209.132.183.28]:33725) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OmXUG-0007vM-AK for qemu-devel@nongnu.org; Fri, 20 Aug 2010 15:42:48 -0400 Received: from int-mx01.intmail.prod.int.phx2.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id o7KJgl1k001374 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 20 Aug 2010 15:42:47 -0400 Received: from localhost (ovpn-113-57.phx2.redhat.com [10.3.113.57]) by int-mx01.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id o7KJgkxD031772; Fri, 20 Aug 2010 15:42:47 -0400 From: Luiz Capitulino To: qemu-devel@nongnu.org Date: Fri, 20 Aug 2010 16:42:31 -0300 Message-Id: <1282333352-4152-4-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1282333352-4152-1-git-send-email-lcapitulino@redhat.com> References: <1282333352-4152-1-git-send-email-lcapitulino@redhat.com> X-Scanned-By: MIMEDefang 2.67 on 10.5.11.11 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. Cc: aliguori@us.ibm.com, armbru@redhat.com Subject: [Qemu-devel] [PATCH 3/4] QMP doc: Add 'Stability Considerations' section X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Signed-off-by: Luiz Capitulino --- qemu-monitor.hx | 26 ++++++++++++++++++++++++-- 1 files changed, 24 insertions(+), 2 deletions(-) diff --git a/qemu-monitor.hx b/qemu-monitor.hx index 9c27b31..5c1da33 100644 --- a/qemu-monitor.hx +++ b/qemu-monitor.hx @@ -35,7 +35,29 @@ information on the Server command and response formats. NOTE: This document is temporary and will be replaced soon. -1. Regular Commands +1. Stability Considerations +=========================== + +The current QMP command set (described in this file) may be useful for a +number of use cases, however it's limited and several commands have bad +defined semantics, specially with regard to command completion. + +These problems are going to be solved incrementally in the next QEMU releases +and we're going to establish a deprecation policy for badly defined commands. + +If you're planning to adopt QMP, please observe the following: + + 1. The deprecation policy will take efect and be documented soon, please + check the documentation of each used command as soon as a new release of + QEMU is available + + 2. DO NOT rely on anything which is not explicit documented + + 3. Errors, in special, are not documented. Applications should NOT check + for specific errors classes or data (it's strongly recommended to only + check for the "error" key) + +2. Regular Commands =================== Server's responses in the examples below are always a success response, please @@ -1592,7 +1614,7 @@ HXCOMM This is required for the QMP documentation layout. SQMP -2. Query Commands +3. Query Commands ================= EQMP