Re: [Qemu-ppc] [PATCH RFC 04/10] virtio-pmem: Prototype

[Eric Blake]

On 1/21/19 7:31 AM, David Hildenbrand wrote:

>>>>>  ##
>>>>>  # @MemoryDeviceInfo:
>>>>>  #
>>>>> @@ -2958,7 +2981,8 @@
>>>>>  ##
>>>>>  { 'union': 'MemoryDeviceInfo',
>>>>
>>>> Does this union need a documentation update that virtio-pmem was added
>>>> in 4.0?
>>>
>>> Seems like:
>>>
>>> ##
>>> # @MemoryDeviceInfo:
>>> #
>>> # Union containing information about a memory device
>>> #
>>> # @dimm: Information about a pc-dimm device.
>>> #
>>> # @nvdimm: Information about a nvdimm device. (since 2.12)
>>> #
>>> # @virtio-pmem: Information about a virtio-pmem device. (since 4.0)
>>> #
>>> # Since: 2.1
>>> ##
>>>
>>> Does not work.
>>>
>>> In file included from /home/dhildenb/git/qemu/qapi/qapi-schema.json:97:
>>> /home/dhildenb/git/qemu/qapi/misc.json:2975: The following documented
>>> members are not in the declaration: dimm, nvdimm, virtio-pmem
>>>
>>> Any idea how to document this correctly?
>>
>> No I don't, but looking at other Union's they only ever seem to document
>> the base members, not the data members, for example see CpuInfo.
>>
> 
> Yes, that's also what I noticed. Guess I'll simply change that to
> 
> "nvdimm is included since 2.12. virtio-pmem is included since 4.0."

Seems okay to me if we can't come up with something better.

> 
> Unless Eric has another idea.

Or maybe Markus, since he's more familiar with the doc generator.

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

signature.asc
Description: OpenPGP digital signature