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 5DACDC44524 for ; Thu, 23 Jul 2026 04:55:36 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1wmlSl-0007a3-1V; Thu, 23 Jul 2026 00:55:15 -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 1wmlSi-0007QI-RU for qemu-trivial@nongnu.org; Thu, 23 Jul 2026 00:55:12 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wmlSg-0005Kq-6F for qemu-trivial@nongnu.org; Thu, 23 Jul 2026 00:55:12 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1784782509; 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=5mqCvm2ktjlYMsJL+/1197LnuW9YBvA42lCVgEVbiMk=; b=E4eB6K7rubQUAShwrHUlh+Av+9ue7v9MA+IOQN1F+GfvR67y2igMKNhnIlNlZNssya2AsI 3KWV2UQffrZXyNgup2/6uUh/R4DYOrfLj624JoPJARG485R0nrupSAhzYpK7/9hIjLHLkU /ioXCtrdmjpe7KP6fhmgXT7R1B0Icss= Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-178-onnmSIaEMbqeSBBvoArGhA-1; Thu, 23 Jul 2026 00:55:05 -0400 X-MC-Unique: onnmSIaEMbqeSBBvoArGhA-1 X-Mimecast-MFC-AGG-ID: onnmSIaEMbqeSBBvoArGhA_1784782502 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 607581800578; Thu, 23 Jul 2026 04:55:02 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.44]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id BEA13180029D; Thu, 23 Jul 2026 04:54:52 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , Lukas Straub , Vladimir Sementsov-Ogievskiy , Zhao Liu , Laurent Vivier , Markus Armbruster , "Gonglei (Arei)" , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Alex Williamson , zhenwei pi , Hanna Reitz , Ani Sinha , qemu-block@nongnu.org, Paolo Bonzini , Peter Xu , Kevin Wolf , linux-cxl@vger.kernel.org, Jiri Pirko , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Stefan Berger , Fabiano Rosas , John Snow , Stefan Hajnoczi , Michael Tokarev , Igor Mammedov , "Michael S. Tsirkin" , Gerd Hoffmann , Mauro Carvalho Chehab , linux-edac@vger.kernel.org, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Richard Henderson , Eric Blake , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , Jason Wang , qemu-trivial@nongnu.org, Jonathan Cameron Subject: [PATCH v2 41/44] qapi: convert trivial intro sections for ui.json Date: Thu, 23 Jul 2026 00:48:02 -0400 Message-ID: <20260723044805.527643-42-jsnow@redhat.com> In-Reply-To: <20260723044805.527643-1-jsnow@redhat.com> References: <20260723044805.527643-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-MFC-PROC-ID: CMwwF3zF9QAf7zreepoR566e6yt1iEEf8KEp5n6HnH0_1784782502 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true Received-SPF: permerror client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com 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_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_PASS=-0.001, T_SPF_PERMERROR=0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-trivial@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-trivial-bounces+qemu-trivial=archiver.kernel.org@nongnu.org Sender: qemu-trivial-bounces+qemu-trivial=archiver.kernel.org@nongnu.org (Trivial) Signed-off-by: John Snow --- qapi/ui.json | 215 ++++++++++++++++++--------------------------------- 1 file changed, 75 insertions(+), 140 deletions(-) diff --git a/qapi/ui.json b/qapi/ui.json index b2c42a7f578..b4122b2fa9f 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -13,8 +13,7 @@ ## # @DisplayProtocol: -# -# Display protocols which support changing password options. +# Display protocols which support changing password options. # # Since: 7.0 ## @@ -23,9 +22,8 @@ ## # @SetPasswordAction: -# -# An action to take on changing a password on a connection with active -# clients. +# An action to take on changing a password on a connection with +# active clients. # # @keep: maintain existing clients # @@ -40,8 +38,7 @@ ## # @SetPasswordOptions: -# -# Options for `set_password`. +# Options for `set_password`. # # @protocol: # - 'vnc' to modify the VNC server password @@ -64,8 +61,7 @@ ## # @SetPasswordOptionsVnc: -# -# Options for `set_password` specific to the VNC protocol. +# Options for `set_password` specific to the VNC protocol. # # @display: The id of the display where the password should be # changed. Defaults to the first. @@ -77,8 +73,7 @@ ## # @set_password: -# -# Set the password of a remote display server. +# Set the password of a remote display server. # # Errors: # - If Spice is not enabled, DeviceNotFound @@ -95,8 +90,7 @@ ## # @ExpirePasswordOptions: -# -# General options for `expire_password`. +# General options for `expire_password`. # # @protocol: # - 'vnc' to modify the VNC server expiration @@ -125,8 +119,7 @@ ## # @ExpirePasswordOptionsVnc: -# -# Options for `expire_password` specific to the VNC protocol. +# Options for `expire_password` specific to the VNC protocol. # # @display: The id of the display where the expiration should be # changed. Defaults to the first. @@ -138,8 +131,7 @@ ## # @expire_password: -# -# Expire the password of a remote display server. +# Expire the password of a remote display server. # # Errors: # - If @protocol is 'spice' and Spice is not active, @@ -157,8 +149,7 @@ ## # @ImageFormat: -# -# Supported image format types. +# Supported image format types. # # @png: PNG format # @@ -171,8 +162,7 @@ ## # @screendump: -# -# Capture the contents of a screen and write it to a file. +# Capture the contents of a screen and write it to a file. # # @filename: the path of a new file to store the image # @@ -208,8 +198,7 @@ ## # @SpiceBasicInfo: -# -# The basic information for SPICE network connection +# The basic information for SPICE network connection # # @host: IP address # @@ -227,8 +216,7 @@ ## # @SpiceServerInfo: -# -# Information about a SPICE server +# Information about a SPICE server # # @auth: authentication method # @@ -241,8 +229,7 @@ ## # @SpiceChannel: -# -# Information about a SPICE client channel. +# Information about a SPICE client channel. # # @connection-id: SPICE connection id number. All channels with the # same id belong to the same SPICE session. @@ -267,8 +254,7 @@ ## # @SpiceQueryMouseMode: -# -# An enumeration of Spice mouse states. +# An enumeration of Spice mouse states. # # @client: Mouse cursor position is determined by the client. # @@ -285,8 +271,7 @@ ## # @SpiceInfo: -# -# Information about the SPICE session. +# Information about the SPICE session. # # @enabled: true if the SPICE server is enabled, false otherwise # @@ -325,8 +310,7 @@ ## # @query-spice: -# -# Return information about the current SPICE server +# Return information about the current SPICE server # # Since: 0.14 # @@ -370,8 +354,7 @@ ## # @SPICE_CONNECTED: -# -# Emitted when a SPICE client establishes a connection +# Emitted when a SPICE client establishes a connection # # @server: server information # @@ -395,9 +378,8 @@ ## # @SPICE_INITIALIZED: -# -# Emitted after initial handshake and authentication takes place (if -# any) and the SPICE channel is up and running +# Emitted after initial handshake and authentication takes place +# (if any) and the SPICE channel is up and running # # @server: server information # @@ -423,8 +405,7 @@ ## # @SPICE_DISCONNECTED: -# -# Emitted when the SPICE connection is closed +# Emitted when the SPICE connection is closed # # @server: server information # @@ -448,8 +429,7 @@ ## # @SPICE_MIGRATE_COMPLETED: -# -# Emitted when SPICE migration has completed +# Emitted when SPICE migration has completed # # Since: 1.3 # @@ -468,8 +448,7 @@ ## # @VncBasicInfo: -# -# The basic information for vnc network connection +# The basic information for vnc network connection # # @host: IP address # @@ -492,8 +471,7 @@ ## # @VncServerInfo: -# -# The network connection information for server +# The network connection information for server # # @auth: authentication method used for the plain (non-websocket) VNC # server @@ -507,8 +485,7 @@ ## # @VncClientInfo: -# -# Information about a connected VNC client. +# Information about a connected VNC client. # # @x509_dname: If x509 authentication is in use, the Distinguished # Name of the client. @@ -525,8 +502,7 @@ ## # @VncInfo: -# -# Information about the VNC session. +# Information about the VNC session. # # @enabled: true if the VNC server is enabled, false otherwise # @@ -576,8 +552,7 @@ ## # @VncPrimaryAuth: -# -# vnc primary authentication method. +# vnc primary authentication method. # # Since: 2.3 ## @@ -588,8 +563,7 @@ ## # @VncVencryptSubAuth: -# -# vnc sub authentication method with vencrypt. +# vnc sub authentication method with vencrypt. # # Since: 2.3 ## @@ -603,8 +577,7 @@ ## # @VncServerInfo2: -# -# The network connection information for server +# The network connection information for server # # @auth: The current authentication type used by the servers # @@ -621,8 +594,7 @@ ## # @VncInfo2: -# -# Information about a vnc server +# Information about a vnc server # # @id: vnc server name. # @@ -655,8 +627,7 @@ ## # @query-vnc: -# -# Return information about the current VNC server +# Return information about the current VNC server # # Since: 0.14 # @@ -685,8 +656,7 @@ ## # @query-vnc-servers: -# -# Return a list of vnc servers. The list can be empty. +# Return a list of vnc servers. The list can be empty. # # Since: 2.3 ## @@ -695,8 +665,7 @@ ## # @change-vnc-password: -# -# Change the VNC server password. +# Change the VNC server password. # # @password: the new password to use with VNC authentication # @@ -712,8 +681,7 @@ ## # @VNC_CONNECTED: -# -# Emitted when a VNC client establishes a connection +# Emitted when a VNC client establishes a connection # # @server: server information # @@ -741,9 +709,8 @@ ## # @VNC_INITIALIZED: -# -# Emitted after authentication takes place (if any) and the VNC -# session is made active +# Emitted after authentication takes place (if any) and the VNC +# session is made active # # @server: server information # @@ -768,8 +735,7 @@ ## # @VNC_DISCONNECTED: -# -# Emitted when the connection is closed +# Emitted when the connection is closed # # @server: server information # @@ -800,8 +766,7 @@ ## # @MouseInfo: -# -# Information about a mouse device. +# Information about a mouse device. # # @name: the name of the mouse device # @@ -820,8 +785,7 @@ ## # @query-mice: -# -# Return information about each active mouse device +# Return information about each active mouse device # # Returns: a list of info for each device # @@ -850,10 +814,9 @@ ## # @QKeyCode: +# An enumeration of key name. # -# An enumeration of key name. -# -# This is used by the `send-key` command. +# This is used by the `send-key` command. # # @unmapped: since 2.0 # @@ -1005,8 +968,7 @@ ## # @KeyValue: -# -# Represents a keyboard key. +# Represents a keyboard key. # # @type: key encoding # @@ -1021,8 +983,7 @@ ## # @send-key: -# -# Send keys to guest. +# Send keys to guest. # # @keys: An array of `KeyValue` elements. All @KeyValues in this # array are simultaneously sent to the guest. A `KeyValue`.number @@ -1050,8 +1011,7 @@ ## # @InputButton: -# -# Button of a pointer input device (mouse, tablet). +# Button of a pointer input device (mouse, tablet). # # @side: front side button of a 5-button mouse (since 2.9) # @@ -1067,8 +1027,7 @@ ## # @InputAxis: -# -# Position axis of a pointer input device (mouse, tablet). +# Position axis of a pointer input device (mouse, tablet). # # Since: 2.0 ## @@ -1077,8 +1036,7 @@ ## # @InputMultiTouchType: -# -# Type of a multi-touch event. +# Type of a multi-touch event. # # @begin: A new touch event sequence has just started. # @@ -1097,8 +1055,7 @@ ## # @InputKeyEvent: -# -# Keyboard input event. +# Keyboard input event. # # @key: Which key this event is for. # @@ -1112,8 +1069,7 @@ ## # @InputBtnEvent: -# -# Pointer button input event. +# Pointer button input event. # # @button: Which button this event is for. # @@ -1127,8 +1083,7 @@ ## # @InputMoveEvent: -# -# Pointer motion input event. +# Pointer motion input event. # # @axis: Which axis is referenced by @value. # @@ -1143,8 +1098,7 @@ ## # @InputMultiTouchEvent: -# -# MultiTouch input event. +# MultiTouch input event. # # @type: The type of multi-touch event. # @@ -1226,8 +1180,7 @@ ## # @InputEvent: -# -# Input event union. +# Input event union. # # @type: the type of input event # @@ -1316,8 +1269,7 @@ ## # @DisplayGTK: -# -# GTK display options. +# GTK display options. # # @clipboard: Enable host-guest clipboard sharing. Defaults to "off". # (Since 11.1) @@ -1357,8 +1309,7 @@ ## # @DisplayEGLHeadless: -# -# EGL headless display options. +# EGL headless display options. # # @rendernode: Which DRM render node should be used. Default is the # first available node on the host. @@ -1370,8 +1321,7 @@ ## # @DisplayDBus: -# -# DBus display options. +# DBus display options. # # @addr: The D-Bus bus address (default to the session bus). # @@ -1393,8 +1343,7 @@ ## # @DisplayGLMode: -# -# Display OpenGL mode. +# Display OpenGL mode. # # @off: Disable OpenGL (default). # @@ -1413,8 +1362,7 @@ ## # @DisplayCurses: -# -# Curses display options. +# Curses display options. # # @charset: Font charset used by guest (default: CP437). # @@ -1425,8 +1373,7 @@ ## # @DisplayCocoa: -# -# Cocoa display options. +# Cocoa display options. # # @left-command-key: Enable/disable forwarding of left command key to # guest. Allows command-tab window switching on the host without @@ -1461,8 +1408,8 @@ ## # @HotKeyMod: -# -# Set of modifier keys that need to be held for shortcut key actions. +# Set of modifier keys that need to be held for shortcut key +# actions. # # Since: 7.1 ## @@ -1471,8 +1418,7 @@ ## # @DisplaySDL: -# -# SDL2 display options. +# SDL2 display options. # # @grab-mod: Modifier keys that should be pressed together with the # "G" key to release the mouse grab. @@ -1484,8 +1430,7 @@ ## # @DisplayType: -# -# Display (user interface) type. +# Display (user interface) type. # # @default: The default user interface, selecting from the first # available of gtk, sdl, cocoa, and vnc. @@ -1535,8 +1480,7 @@ ## # @DisplayOptions: -# -# Display (user interface) options. +# Display (user interface) options. # # @type: Which `DisplayType` QEMU should use. # @@ -1573,8 +1517,7 @@ ## # @query-display-options: -# -# Return information about display configuration +# Return information about display configuration # # Since: 3.1 ## @@ -1583,8 +1526,7 @@ ## # @DisplayReloadType: -# -# Available DisplayReload types. +# Available DisplayReload types. # # @vnc: VNC display # @@ -1595,8 +1537,7 @@ ## # @DisplayReloadOptionsVNC: -# -# Specify the VNC reload options. +# Specify the VNC reload options. # # @tls-certs: reload tls certs or not. # @@ -1607,8 +1548,7 @@ ## # @DisplayReloadOptions: -# -# Options of the display configuration reload. +# Options of the display configuration reload. # # @type: Specify the display type. # @@ -1621,8 +1561,7 @@ ## # @display-reload: -# -# Reload display configuration. +# Reload display configuration. # # Since: 6.0 # @@ -1638,8 +1577,7 @@ ## # @DisplayUpdateType: -# -# Available DisplayUpdate types. +# Available DisplayUpdate types. # # @vnc: VNC display # @@ -1650,8 +1588,7 @@ ## # @DisplayUpdateOptionsVNC: -# -# Specify the VNC reload options. +# Specify the VNC reload options. # # @addresses: If specified, change set of addresses to listen for # connections. Addresses configured for websockets are not @@ -1664,8 +1601,7 @@ ## # @DisplayUpdateOptions: -# -# Options of the display configuration reload. +# Options of the display configuration reload. # # @type: Specify the display type. # @@ -1678,8 +1614,7 @@ ## # @display-update: -# -# Update display configuration. +# Update display configuration. # # Since: 7.1 # @@ -1697,10 +1632,10 @@ ## # @client_migrate_info: -# -# Set migration information for remote display. This makes the server -# ask the client to automatically reconnect using the new parameters -# once migration finished successfully. Only implemented for SPICE. +# Set migration information for remote display. This makes the +# server ask the client to automatically reconnect using the new +# parameters once migration finished successfully. Only +# implemented for SPICE. # # @protocol: must be "spice" # -- 2.55.0