| Message ID | 20200206173040.17337-5-peter.maydell@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > 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 I expected a funny rendering, but not this one. The doc generator is full of surprises... > > "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> > --- > 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 > ## Reviewed-by: Markus Armbruster <armbru@redhat.com>
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 ##
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> --- qga/qapi-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)