[PATCH v2 41/44] qapi: convert trivial intro sections for ui.json
John Snow <[email protected]> Thu, 23 Jul 2026 00:48:02 -0400
| Newsgroups | org.nongnu.qemu-trivial,org.kernel.vger.linux-cxl,org.kernel.vger.linux-edac,org.nongnu.qemu-devel |
|---|---|
| Message-ID | <[email protected]> |
(Trivial) Signed-off-by: John Snow <[email protected]> --- 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