Re: [Qemu-devel] [PATCH v8 14/21] (SQUASHED) move doc to schema

[Eric Blake]

On 01/13/2017 08:41 AM, Marc-André Lureau wrote:
> qmp-commands: move 'add_client' doc to schema
> 

Sadly, the squashed version introduced some documentation regressions.
For example, the documentation for blockdev-snapshot (got merged as
commit 3282eca4):

> @@ -983,9 +1193,31 @@
>  #
>  # Generates a snapshot of a block device.
>  #
> +# Create a snapshot, by installing 'node' as the backing image of
> +# 'overlay'. Additionally, if 'node' is associated with a block
> +# device, the block device changes to using 'overlay' as its new active
> +# image.
> +#
>  # For the arguments, see the documentation of BlockdevSnapshot.
>  #
>  # Since: 2.5
> +#
> +# Example:
> +#
> +# -> { "execute": "blockdev-add",
> +#      "arguments": { "options": { "driver": "qcow2",
> +#                                  "node-name": "node1534",
> +#                                  "file": { "driver": "file",
> +#                                            "filename": "hd1.qcow2" },
> +#                                  "backing": "" } } }
> +#
> +# <- { "return": {} }
> +#
> +# -> { "execute": "blockdev-snapshot",
> +#      "arguments": { "node": "ide-hd0",
> +#                     "overlay": "node1534" } }
> +# <- { "return": {} }
> +#

reintroduced the bogus 'options' layer, which was not present in the
pre-move text:

> -blockdev-snapshot
> ------------------
> -Since 2.5
> -
> -Create a snapshot, by installing 'node' as the backing image of
> -'overlay'. Additionally, if 'node' is associated with a block
> -device, the block device changes to using 'overlay' as its new active
> -image.
> -
> -Arguments:
> -
> -- "node": device that will have a snapshot created (json-string)
> -- "overlay": device that will have 'node' as its backing image (json-string)
> -
> -Example:
> -
> --> { "execute": "blockdev-add",
> -                "arguments": { "driver": "qcow2",
> -                               "node-name": "node1534",
> -                               "file": { "driver": "file",
> -                                         "filename": "hd1.qcow2" },
> -                               "backing": "" } }
> -
> -<- { "return": {} }
> -
> --> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
> -                                                    "overlay": "node1534" } }
> -<- { "return": {} }
> -

where 'options' had been cleaned up in commit 0153d2f.

I really don't feel like auditing what other doc changes were
inadvertently regressed (probably anything that changed between when
Marc-André first branched his work, and when Markus finally merged it -
which could be several months of commits to double-check); it might be
sufficient to just review commits 65ce54f..c08d644 to look for any
differences?  Is that something we can automate by script?

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

signature.asc
Description: OpenPGP digital signature