diff mbox series

[04/12] qapi: Tidy up indentation of add_client's example

Message ID 20240322140910.328840-5-armbru@redhat.com
State New
Headers show
Series qapi: Fairly trivial documentation work | expand

Commit Message

Markus Armbruster March 22, 2024, 2:09 p.m. UTC
Commit d23055b8db8 (qapi: Require descriptions and tagged sections to
be indented) indented add_client's example too much.  Revert that.

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

Comments

Markus Armbruster March 25, 2024, 5:49 a.m. UTC | #1
Markus Armbruster <armbru@redhat.com> writes:

> Commit d23055b8db8 (qapi: Require descriptions and tagged sections to
> be indented) indented add_client's example too much.  Revert that.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/misc.json | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/qapi/misc.json b/qapi/misc.json
> index 1b0c5dad88..ec30e5c570 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -32,9 +32,9 @@
>  #
>  # Example:
>  #
> -#         -> { "execute": "add_client", "arguments": { "protocol": "vnc",
> -#                                                      "fdname": "myclient" } }
> -#         <- { "return": {} }
> +#     -> { "execute": "add_client", "arguments": { "protocol": "vnc",
> +#                                                  "fdname": "myclient" } }
> +#     <- { "return": {} }
>  ##
>  { 'command': 'add_client',
>    'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
> @@ -142,7 +142,7 @@
>  #     option was passed on the command line.
>  #
>  #     In the "suspended" state, it will completely stop the VM and
> -#     cause a transition to the "paused" state. (Since 9.0)
> +#     cause a transition to the "paused" state.  (Since 9.0)
>  #
>  # Example:
>  #

This hunk belongs to PATCH 11.
diff mbox series

Patch

diff --git a/qapi/misc.json b/qapi/misc.json
index 1b0c5dad88..ec30e5c570 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -32,9 +32,9 @@ 
 #
 # Example:
 #
-#         -> { "execute": "add_client", "arguments": { "protocol": "vnc",
-#                                                      "fdname": "myclient" } }
-#         <- { "return": {} }
+#     -> { "execute": "add_client", "arguments": { "protocol": "vnc",
+#                                                  "fdname": "myclient" } }
+#     <- { "return": {} }
 ##
 { 'command': 'add_client',
   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
@@ -142,7 +142,7 @@ 
 #     option was passed on the command line.
 #
 #     In the "suspended" state, it will completely stop the VM and
-#     cause a transition to the "paused" state. (Since 9.0)
+#     cause a transition to the "paused" state.  (Since 9.0)
 #
 # Example:
 #