diff mbox series

[4/5] qga: Move type description right after type name

Message ID 20240129115008.674248-5-armbru@redhat.com
State New
Headers show
Series qmp: Documentation cleanups | expand

Commit Message

Markus Armbruster Jan. 29, 2024, 11:50 a.m. UTC
Documentation of type BlockdevOptionsIscsi describes the type's
purpose after its members.  Everywhere else, we do it the other way
round.  Move it for consistency.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/block-core.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Konstantin Kostiuk Jan. 29, 2024, 4:21 p.m. UTC | #1
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>

On Mon, Jan 29, 2024 at 1:50 PM Markus Armbruster <armbru@redhat.com> wrote:

> Documentation of type BlockdevOptionsIscsi describes the type's
> purpose after its members.  Everywhere else, we do it the other way
> round.  Move it for consistency.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/block-core.json | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 530c4af50f..781c9bd03e 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -4070,6 +4070,8 @@
>  ##
>  # @BlockdevOptionsIscsi:
>  #
> +# Driver specific block device options for iscsi
> +#
>  # @transport: The iscsi transport type
>  #
>  # @portal: The address of the iscsi portal
> @@ -4094,8 +4096,6 @@
>  # @timeout: Timeout in seconds after which a request will timeout.  0
>  #     means no timeout and is the default.
>  #
> -# Driver specific block device options for iscsi
> -#
>  # Since: 2.9
>  ##
>  { 'struct': 'BlockdevOptionsIscsi',
> --
> 2.43.0
>
>
diff mbox series

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 530c4af50f..781c9bd03e 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -4070,6 +4070,8 @@ 
 ##
 # @BlockdevOptionsIscsi:
 #
+# Driver specific block device options for iscsi
+#
 # @transport: The iscsi transport type
 #
 # @portal: The address of the iscsi portal
@@ -4094,8 +4096,6 @@ 
 # @timeout: Timeout in seconds after which a request will timeout.  0
 #     means no timeout and is the default.
 #
-# Driver specific block device options for iscsi
-#
 # Since: 2.9
 ##
 { 'struct': 'BlockdevOptionsIscsi',