From 4ae65a52658c264caebcb3a31effccf582822a6d Mon Sep 17 00:00:00 2001 From: Andrea Bolognani Date: Tue, 3 May 2022 09:37:32 +0200 Subject: [PATCH] qapi: Add missing separators between sections This only affects readability. The generated documentation doesn't change. Signed-off-by: Andrea Bolognani Reviewed-by: Markus Armbruster Message-Id: <20220503073737.84223-4-abologna@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- qapi/block-core.json | 5 +++++ qapi/block.json | 1 + qapi/crypto.json | 7 +++++++ qapi/machine.json | 1 + qapi/migration.json | 4 ++++ 5 files changed, 18 insertions(+) diff --git a/qapi/block-core.json b/qapi/block-core.json index b66494e8c5..34dae298ee 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1744,6 +1744,7 @@ # Since: 2.3 # # Example: +# # -> { "execute": "blockdev-backup", # "arguments": { "device": "src-id", # "sync": "full", @@ -2008,6 +2009,7 @@ # @on-target-error: the action to take on an error on the target, # default 'report' (no limitations, since this applies to # a different block device than @device). +# # @unmap: Whether to try to unmap target sectors where source has # only zero. If true, and target unallocated sectors will read as zero, # target image sectors will be unmapped; otherwise, zeroes will be @@ -2029,6 +2031,7 @@ # When true, this job will automatically disappear from the query # list without user intervention. # Defaults to true. (Since 3.1) +# # Since: 1.3 ## { 'struct': 'DriveMirror', @@ -2342,6 +2345,7 @@ # When true, this job will automatically disappear from the query # list without user intervention. # Defaults to true. (Since 3.1) +# # Returns: nothing on success. # # Since: 2.6 @@ -4139,6 +4143,7 @@ # @throttle-group: the name of the throttle-group object to use. It # must already exist. # @file: reference to or definition of the data source block device +# # Since: 2.11 ## { 'struct': 'BlockdevOptionsThrottle', diff --git a/qapi/block.json b/qapi/block.json index 3f100d4887..e0f7898ed1 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -105,6 +105,7 @@ # # Returns: - Nothing on success # - If @device is not a valid block device, DeviceNotFound +# # Notes: Ejecting a device with no media results in success # # Since: 0.14 diff --git a/qapi/crypto.json b/qapi/crypto.json index 8e0b4764e5..21c670eefa 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -32,6 +32,7 @@ # # @raw: raw bytes. When encoded in JSON only valid UTF-8 sequences can be used # @base64: arbitrary base64 encoded binary data +# # Since: 2.6 ## { 'enum': 'QCryptoSecretFormat', @@ -51,6 +52,7 @@ # @sha384: SHA-384. (since 2.7) # @sha512: SHA-512. (since 2.7) # @ripemd160: RIPEMD-160. (since 2.7) +# # Since: 2.6 ## { 'enum': 'QCryptoHashAlgorithm', @@ -75,6 +77,7 @@ # @twofish-128: Twofish with 128 bit / 16 byte keys # @twofish-192: Twofish with 192 bit / 24 byte keys # @twofish-256: Twofish with 256 bit / 32 byte keys +# # Since: 2.6 ## { 'enum': 'QCryptoCipherAlgorithm', @@ -95,6 +98,7 @@ # @cbc: Cipher Block Chaining # @xts: XEX with tweaked code book and ciphertext stealing # @ctr: Counter (Since 2.8) +# # Since: 2.6 ## { 'enum': 'QCryptoCipherMode', @@ -114,6 +118,7 @@ # @plain: 64-bit sector number truncated to 32-bits # @plain64: 64-bit sector number # @essiv: 64-bit sector number encrypted with a hash of the encryption key +# # Since: 2.6 ## { 'enum': 'QCryptoIVGenAlgorithm', @@ -170,6 +175,7 @@ # @key-secret: the ID of a QCryptoSecret object providing the # decryption key. Mandatory except when probing image for # metadata only. +# # Since: 2.6 ## { 'struct': 'QCryptoBlockOptionsLUKS', @@ -194,6 +200,7 @@ # @iter-time: number of milliseconds to spend in # PBKDF passphrase processing. Currently defaults # to 2000. (since 2.8) +# # Since: 2.6 ## { 'struct': 'QCryptoBlockCreateOptionsLUKS', diff --git a/qapi/machine.json b/qapi/machine.json index c9bdae40eb..79901e1c09 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -299,6 +299,7 @@ # returning does not indicate that a guest has accepted the request or # that it has shut down. Many guests will respond to this command by # prompting the user in some way. +# # Example: # # -> { "execute": "system_powerdown" } diff --git a/qapi/migration.json b/qapi/migration.json index 409eb086a2..fc1c157d3f 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -1422,7 +1422,9 @@ # @state: The state the migration is currently expected to be in # # Returns: nothing on success +# # Since: 2.11 +# # Example: # # -> { "execute": "migrate-continue" , "arguments": @@ -1736,6 +1738,7 @@ # Since: 4.2 # # Example: +# # <- { "event": "UNPLUG_PRIMARY", # "data": { "device-id": "hostdev0" }, # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } @@ -1845,6 +1848,7 @@ # Since: 5.2 # # Example: +# # {"execute": "calc-dirty-rate", "arguments": {"calc-time": 1, # 'sample-pages': 512} } #