Re: [PATCH v3 18/30] docstring: Fix generated documentation of virStorageVolInfoFlags
On Thu, Apr 21, 2022 at 08:24:39PM +0200, Victor Toso wrote:
On Thu, Apr 21, 2022 at 03:48:51PM +0200, Peter Krempa wrote:
> Actually, this paragraph is inaccurate since the commits were renamed.
>
> I'd prefer a standalone description of what's going on so since this
> patch is okay itself I'll probably go with:
>
> The API xml description file generator doesn't properly handle cases
> when there's either a single comment or mixed use of pre- and post-
> comments explaining the values.
>
> Modify the comments to avoid the problem and also append version
> information for the exposed values.
Ack!
In addition to what Peter said, changes that are fixing the existing
comments so that they are handled correctly by apibuild.py should not
be mixed with changes that are adding version numbers. The former
should happen in their own patches at the beginning of the series,
which we should be able to push right away even as the rest of the
changes are still being tweaked.
Patch 3/30 is an example of this being done right, both when it comes
to its actual contents and its position in the series. This patch and
the next few ones are not, and should be changed to look more like
3/30.
--
Andrea Bolognani / Red Hat / Virtualization