From: Eric Blake <eblake@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: Michael Roth <mdroth@linux.vnet.ibm.com>
Subject: Re: [PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment
Date: Mon, 3 Feb 2020 10:04:17 -0600 [thread overview]
Message-ID: <359ec2dd-758b-c21a-3aa1-a60e7eab385b@redhat.com> (raw)
In-Reply-To: <20200203154905.13252-1-peter.maydell@linaro.org>
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
prev parent reply other threads:[~2020-02-03 16:05 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-03 15:49 [PATCH] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Peter Maydell
2020-02-03 16:04 ` Eric Blake [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=359ec2dd-758b-c21a-3aa1-a60e7eab385b@redhat.com \
--to=eblake@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).