[PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment

[PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment

[Peter Maydell]

The doc comment for GuestDiskBusType doesn't match up with the
enumeration because of a missing hyphen in 'file-backed-virtual'.
This means the docs are rendered wrongly:
       "virtual"
           Win virtual bus type "file-backed" virtual: Win file-backed bus type

       "file-backed-virtual"
           Not documented

Add the missing hyphen.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
I noticed this while I was working on generation of rST format
documentation from the json doc comments. This is a prerequisite
for that work, so nobody needs to queue this patch (I'll include
it in my series along with some other mere-formatting fixes for
the doc comments) but I thought I might as well send it out
for review now so it doesn't get lost in a big boring-looking
Sphinx/rST patchset :-)

 qga/qapi-schema.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index fb4605cc19c..23ce6af597d 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -809,7 +809,7 @@
 # @sas: Win serial-attaches SCSI bus type
 # @mmc: Win multimedia card (MMC) bus type
 # @virtual: Win virtual bus type
-# @file-backed virtual: Win file-backed bus type
+# @file-backed-virtual: Win file-backed bus type
 #
 # Since: 2.2; 'Unknown' and all entries below since 2.4
 ##
-- 
2.20.1

Re: [PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment

[Eric Blake]

On 2/3/20 9:49 AM, Peter Maydell wrote:
> The doc comment for GuestDiskBusType doesn't match up with the
> enumeration because of a missing hyphen in 'file-backed-virtual'.
> This means the docs are rendered wrongly:
>         "virtual"
>             Win virtual bus type "file-backed" virtual: Win file-backed bus type
> 
>         "file-backed-virtual"
>             Not documented
> 
> Add the missing hyphen.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---

Reviewed-by: Eric Blake <eblake@redhat.com>

> I noticed this while I was working on generation of rST format
> documentation from the json doc comments. This is a prerequisite
> for that work, so nobody needs to queue this patch (I'll include
> it in my series along with some other mere-formatting fixes for
> the doc comments) but I thought I might as well send it out
> for review now so it doesn't get lost in a big boring-looking
> Sphinx/rST patchset :-)
> 

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