From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 2068BC43458 for ; Wed, 1 Jul 2026 07:27:51 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1wepLy-0004j4-Gl; Wed, 01 Jul 2026 03:27:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wepLx-0004if-D7 for qemu-devel@nongnu.org; Wed, 01 Jul 2026 03:27:25 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wepLv-0004mt-HC for qemu-devel@nongnu.org; Wed, 01 Jul 2026 03:27:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1782890841; 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=5w+YcSRWa96uwGmTO7z4aHRknvgZdkDmX6JnAy9ZmX0=; b=Jvm218JFhDQO2nKcuL0IxvrCM6TLfs31JANpP9I3XOFB1Kb4KIQW5og3xPmkYU5RkJGIp3 0NBrW+vxsBkbS0YLet2R8ONWc7Ht1HNE7kmtYocjlX/eGZfm0yXz1+X40pXzHJSZjkpS8g CIUYoB97lxa7kkTcpXu5U5xAaFk8aks= Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-351-pTkmTbzbOvmEHPbAtNoJkA-1; Wed, 01 Jul 2026 03:27:17 -0400 X-MC-Unique: pTkmTbzbOvmEHPbAtNoJkA-1 X-Mimecast-MFC-AGG-ID: pTkmTbzbOvmEHPbAtNoJkA_1782890836 Received: from mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.95]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id DC11C18E6A72; Wed, 1 Jul 2026 07:27:15 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.4]) by mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id D27F736F00; Wed, 1 Jul 2026 07:27:14 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6684321E6920; Wed, 01 Jul 2026 09:27:12 +0200 (CEST) From: Markus Armbruster To: Daniel P. =?utf-8?Q?Berrang=C3=A9?= Cc: qemu-devel@nongnu.org, devel@lists.libvirt.org, =?utf-8?Q?Marc-Andr?= =?utf-8?Q?=C3=A9?= Lureau , Paolo Bonzini , "Dr. David Alan Gilbert" , Alex =?utf-8?Q?Benn=C3=A9e?= , Christian Brauner , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Peter Krempa Subject: Re: [PATCH v5 34/35] qemu-options: document new monitor-hmp and monitor-qmp objects In-Reply-To: <20260624173752.2928717-35-berrange@redhat.com> ("Daniel P. =?utf-8?Q?Berrang=C3=A9=22's?= message of "Wed, 24 Jun 2026 18:37:50 +0100") References: <20260624173752.2928717-1-berrange@redhat.com> <20260624173752.2928717-35-berrange@redhat.com> Date: Wed, 01 Jul 2026 09:27:12 +0200 Message-ID: <87qzln6ugf.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.6 on 10.30.177.95 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 8 X-Spam_score: 0.8 X-Spam_bar: / X-Spam_report: (0.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.445, 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Daniel P. Berrang=C3=A9 writes: > Add new docs for the `-object monitor-hmp` and `-object monitor-qmp` > options, updating `-mon` to state that it is legacy syntax sugar > for the new `-object` args. > > Reviewed-by: Marc-Andr=C3=A9 Lureau > Tested-by: Peter Krempa > Signed-off-by: Daniel P. Berrang=C3=A9 > --- > qemu-options.hx | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 49 insertions(+) > > diff --git a/qemu-options.hx b/qemu-options.hx > index c799286153..a804d5b880 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -4980,6 +4980,16 @@ SRST > -mon chardev=3Dmon1,mode=3Dcontrol,pretty=3Don >=20=20 > enables the QMP monitor on localhost port 4444 with pretty-printing. > + > + The use of ``-mon mode=3Dreadline`` is historical syntax sugar > + for the new ``-object monitor-hmp`` option, each use of which > + creates an object with the ID ``hmpcompatNNN`` where ``NNN`` is > + a counter starting from 0. > + > + The use of ``-mon mode=3Dcontrol`` is historical syntax sugar > + for the new ``-object monitor-qmp`` option, each use of which > + creates an object with the ID ``qmpcompatNNN`` where ``NNN`` is > + a counter starting from 0. > ERST Should we document how -monitor, -qmp, and -qmp-pretty map to -object and -chardev? >=20=20 > DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ > @@ -5730,6 +5740,45 @@ SRST > they are specified. Note that the 'id' property must be set. These > objects are placed in the '/objects' path. >=20=20 > + ``-object monitor-hmp,id=3Did,chardev=3Dchardev_id,readline=3Don|off= `` > + Set up a monitor running the Human Monitor Protocol, > + connected to the chardev ``chardev_id``. > + > + The ``id`` parameter is a unique ID that can be used > + to dynamically delete the monitor at runtime. Note > + that monitors created using the historical syntax > + will be allocated IDs following the pattern ``hmpcompatNN``. > + Mixing ``-object`` with the historical monitor syntax is > + discouraged. > + > + The ``readline`` parameter, which defaults to ``on``, > + controls whether the monitor provides line editing. > + > + ``-object monitor-qmp,id=3Did,chardev=3Dchardev_id,pretty=3Don|off,c= lose-action=3Dnone|delete`` > + Set up a monitor running the QEMU Monitor Protocol, > + connected to the chardev ``chardev_id``. > + > + The ``id`` parameter is a unique ID that can be used > + to dynamically delete the monitor at runtime. Note > + that monitors created using the historical syntax > + will be allocated IDs following the pattern ``qmpcompatNN``. > + Mixing ``-object`` with the historical monitor syntax is > + discouraged. > + > + The ``pretty`` parameter, which defaults to ``off``, > + controls whether the monitor responses are pretty > + printed as multi-line indented JSON, as opposed to > + constrained to a single line without extraneous > + whitespace. > + > + The ``close-action`` parameter, which defaults to ``none``, > + controls what happens when the connection to the monitor > + is terminated by the user. If set to ``delete``, then the > + ``monitor-qmp`` object and its associated character > + device are both immediately deleted. This can be useful > + if an extra monitor was hotplugged for a specific task > + and should be unplugged when completed. > + > ``-object memory-backend-file,id=3Did,size=3Dsize,mem-path=3Ddir,sha= re=3Don|off,discard-data=3Don|off,merge=3Don|off,dump=3Don|off,prealloc=3Do= n|off,host-nodes=3Dhost-nodes,policy=3Ddefault|preferred|bind|interleave,al= ign=3Dalign,offset=3Doffset,readonly=3Don|off,rom=3Don|off|auto`` > Creates a memory file backend object, which can be used to back > the guest RAM with huge pages.