[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType do
|
From: |
Eric Blake |
|
Subject: |
Re: [PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment |
|
Date: |
Mon, 3 Feb 2020 10:04:17 -0600 |
|
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.4.1 |
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 <address@hidden>
---
Reviewed-by: Eric Blake <address@hidden>
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