From nobody Mon Feb 9 01:30:53 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1604452747; cv=none; d=zohomail.com; s=zohoarc; b=KmJBDka7y1+cGzxvh8buZRNrlIeLR8QxqYoKKvoJH8CLpDymohh/yQz8/rDu3ST4MT+/A1q6pQzaR4WmLMRGkygGjJOcwspdit3rBJ+ul5A+KiX0/z952sg3Ux7zdrZy09JpB/ySW0fgV3hcER3C6HSCwAOGBs9vAvvOSLd0Pyw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1604452747; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=r5RN8S6BJ12v6o3a7OQWEM4M5IcdBBkgErIERMbrEj8=; b=OH7PtTnM6gojoz7DiKJXbg6+wfO33TjiA/kNolO8xAMs9JfShDr+38sm6kSxkfyVcl3PzIb3WIF7XLos3qYt3iOqVZssBRgRIBo3/Yj0mvzllYALLqymbtrtosjgoeC3mayKh1byOFASW7AEyNlSalcz1f3H9QfSVKLiFAa6vhk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1604452747234204.83232556796486; Tue, 3 Nov 2020 17:19:07 -0800 (PST) Received: from localhost ([::1]:56118 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ka7Rz-0005XK-QK for importer@patchew.org; Tue, 03 Nov 2020 20:19:01 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:36052) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ka6nz-0007Y6-I5 for qemu-devel@nongnu.org; Tue, 03 Nov 2020 19:37:39 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:35849) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1ka6nx-0004yX-JV for qemu-devel@nongnu.org; Tue, 03 Nov 2020 19:37:39 -0500 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-523-Yxo1hrUCMii8rjTm09aNfQ-1; Tue, 03 Nov 2020 19:37:35 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 463BC108E1A6 for ; Wed, 4 Nov 2020 00:37:34 +0000 (UTC) Received: from scv.redhat.com (ovpn-119-97.rdu2.redhat.com [10.10.119.97]) by smtp.corp.redhat.com (Postfix) with ESMTP id 71ADE55766; Wed, 4 Nov 2020 00:37:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1604450257; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=r5RN8S6BJ12v6o3a7OQWEM4M5IcdBBkgErIERMbrEj8=; b=MUTT3F3Ce/7rLHG4QsLiP7by3qfIFlH4MGnCMakRDkAIjPT9twQ04ieWeo89GsS+NlRrxk 915QNDpXF6Cc3Ob8A95nKvm8rsA6LBD5OW58EopZwuCPWx9qoEjRMLgRr/pB1dx2w6WTYj Q/RWgmV3KviyPrKnqKgZNqidjk3VLCo= X-MC-Unique: Yxo1hrUCMii8rjTm09aNfQ-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v2 66/72] scripts/qmp-shell: convert usage comment to docstring Date: Tue, 3 Nov 2020 19:35:56 -0500 Message-Id: <20201104003602.1293560-67-jsnow@redhat.com> In-Reply-To: <20201104003602.1293560-1-jsnow@redhat.com> References: <20201104003602.1293560-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/03 00:03:41 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Cleber Rosa , John Snow , Markus Armbruster , Eduardo Habkost Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Signed-off-by: John Snow --- scripts/qmp/qmp-shell | 128 ++++++++++++++++++++++++------------------ 1 file changed, 72 insertions(+), 56 deletions(-) diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell index 8d5845ab4815..82fe16cff820 100755 --- a/scripts/qmp/qmp-shell +++ b/scripts/qmp/qmp-shell @@ -1,7 +1,5 @@ #!/usr/bin/env python3 # -# Low-level QEMU shell on top of QMP. -# # Copyright (C) 2009, 2010 Red Hat Inc. # # Authors: @@ -10,60 +8,78 @@ # This work is licensed under the terms of the GNU GPL, version 2. See # the COPYING file in the top-level directory. # -# Usage: -# -# Start QEMU with: -# -# # qemu [...] -qmp unix:./qmp-sock,server -# -# Run the shell: -# -# $ qmp-shell ./qmp-sock -# -# Commands have the following format: -# -# < command-name > [ arg-name1=3Darg1 ] ... [ arg-nameN=3DargN ] -# -# For example: -# -# (QEMU) device_add driver=3De1000 id=3Dnet1 -# {u'return': {}} -# (QEMU) -# -# key=3Dvalue pairs also support Python or JSON object literal subset nota= tions, -# without spaces. Dictionaries/objects {} are supported as are arrays []. -# -# example-command arg-name1=3D{'key':'value','obj'=3D{'prop':"value"}} -# -# Both JSON and Python formatting should work, including both styles of -# string literal quotes. Both paradigms of literal values should work, -# including null/true/false for JSON and None/True/False for Python. -# -# -# Transactions have the following multi-line format: -# -# transaction( -# action-name1 [ arg-name1=3Darg1 ] ... [arg-nameN=3DargN ] -# ... -# action-nameN [ arg-name1=3Darg1 ] ... [arg-nameN=3DargN ] -# ) -# -# One line transactions are also supported: -# -# transaction( action-name1 ... ) -# -# For example: -# -# (QEMU) transaction( -# TRANS> block-dirty-bitmap-add node=3Ddrive0 name=3Dbitmap1 -# TRANS> block-dirty-bitmap-clear node=3Ddrive0 name=3Dbitmap0 -# TRANS> ) -# {"return": {}} -# (QEMU) -# -# Use the -v and -p options to activate the verbose and pretty-print optio= ns, -# which will echo back the properly formatted JSON-compliant QMP that is b= eing -# sent to QEMU, which is useful for debugging and documentation generation. + +""" +Low-level QEMU shell on top of QMP. + +usage: qmp-shell [-h] [-H] [-N] [-v] [-p] qmp_server + +positional arguments: + qmp_server < UNIX socket path | TCP address:port > + +optional arguments: + -h, --help show this help message and exit + -H, --hmp Use HMP interface + -N, --skip-negotiation + Skip negotiate (for qemu-ga) + -v, --verbose Verbose (echo commands sent and received) + -p, --pretty Pretty-print JSON + + +Start QEMU with: + +# qemu [...] -qmp unix:./qmp-sock,server + +Run the shell: + +$ qmp-shell ./qmp-sock + +Commands have the following format: + + < command-name > [ arg-name1=3Darg1 ] ... [ arg-nameN=3DargN ] + +For example: + +(QEMU) device_add driver=3De1000 id=3Dnet1 +{'return': {}} +(QEMU) + +key=3Dvalue pairs also support Python or JSON object literal subset notati= ons, +without spaces. Dictionaries/objects {} are supported as are arrays []. + + example-command arg-name1=3D{'key':'value','obj'=3D{'prop':"value"}} + +Both JSON and Python formatting should work, including both styles of +string literal quotes. Both paradigms of literal values should work, +including null/true/false for JSON and None/True/False for Python. + + +Transactions have the following multi-line format: + + transaction( + action-name1 [ arg-name1=3Darg1 ] ... [arg-nameN=3DargN ] + ... + action-nameN [ arg-name1=3Darg1 ] ... [arg-nameN=3DargN ] + ) + +One line transactions are also supported: + + transaction( action-name1 ... ) + +For example: + + (QEMU) transaction( + TRANS> block-dirty-bitmap-add node=3Ddrive0 name=3Dbitmap1 + TRANS> block-dirty-bitmap-clear node=3Ddrive0 name=3Dbitmap0 + TRANS> ) + {"return": {}} + (QEMU) + +Use the -v and -p options to activate the verbose and pretty-print options, +which will echo back the properly formatted JSON-compliant QMP that is bei= ng +sent to QEMU, which is useful for debugging and documentation generation. +""" + import argparse import ast import json --=20 2.26.2