[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 14/14] vdpa: Add x-svq to NetdevVhostVDPAOptions
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v3 14/14] vdpa: Add x-svq to NetdevVhostVDPAOptions |
Date: |
Fri, 04 Mar 2022 07:29:46 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) |
Eugenio Perez Martin <eperezma@redhat.com> writes:
> Yes, that's right. I expressed my point poorly actually, I'll go the reverse.
>
> qapi-gen.py forces me to write a comment in the doc:
> qapi/block-core.json:2971: feature 'unstable' lacks documentation
>
> When I add the documentation line, it's enough to add @unstable. But
> there is no way to tell if this tag is because the whole struct is
> unstable or if it's because individual members are unstable unless the
> reader either checks the tag or the struct code.
>
> I was mostly worried about doc generators, I would not like to make
> NetdevVhostVDPAOptions unstable at this point. But I see that there is
> no problem with that.
>
> Thanks!
Yes, the doc generator insists on features being documented, and it
doesn't provide for documenting them next to members, only top-level.
The common solution is to phrase the comment like we do in
BlockdevOptionsFile:
# @unstable: Member x-check-cache-dropped is meant for debugging.
If there were multiple members so flagged, we'd enumerate them all.
The generator doesn't check you do this right. The existing check
guards against *forgetting* to do it, not against doing it wrong.
More questions?
- [PATCH v3 09/14] vhost: Add VhostIOVATree, (continued)
- [PATCH v3 09/14] vhost: Add VhostIOVATree, Eugenio Pérez, 2022/03/02
- [PATCH v3 10/14] vdpa: Add custom IOTLB translations to SVQ, Eugenio Pérez, 2022/03/02
- [PATCH v3 11/14] vdpa: Adapt vhost_vdpa_get_vring_base to SVQ, Eugenio Pérez, 2022/03/02
- [PATCH v3 12/14] vdpa: Never set log_base addr if SVQ is enabled, Eugenio Pérez, 2022/03/02
- [PATCH v3 13/14] vdpa: Expose VHOST_F_LOG_ALL on SVQ, Eugenio Pérez, 2022/03/02
- [PATCH v3 14/14] vdpa: Add x-svq to NetdevVhostVDPAOptions, Eugenio Pérez, 2022/03/02