Re: [PATCH v3 00/30] Add 'version' to other exported types
On Fri, Apr 22, 2022 at 10:20:11AM +0200, Peter Krempa wrote:
Based on discussions on individual patches I've applied the
feedback I
had including Andrea's request to remove the extra empty line on the
following patches:
docstring: Fix generated documentation of virStorageVolInfoFlags
docstring: libvirt-common: Add 'Since version' metadata
docstring: function: lxc: Add 'Since version' metadata
docstring: function: qemu: Add 'Since version' metadata
docstring: typedef: qemu:: Add 'Since version' metadata
docstring: typedef: libvirt:: Add 'Since version' metadata
docstring: macros: libvirt: Add 'Since version' metadata
docstring: enums: qemu: Add 'Since version' metadata
docstring: variable: Move docstring from source to header file
docstring: Fix generated documentation of virConnectListAllNodeDeviceFlags
And went ahead and pushed them so that we don't have to keep re-sending
them.
Mh, maybe pushing those patches right now was not an entirely good
idea.
If you build the HTML documentation locally and browse it, you'll
notice that the Since information for many of the symbols is now
showing up, just tacked on to the end.
This is particularly bad for functions, where the result will end up
looking like
Returns 0 on success, -1 on error. Since: v1.0.2
That will of course stop happening once apibuild.py learns to parse
the Since tag and exclude it from the symbol's description.
Are we confident that we can get the rest of the series in before the
next release? I don't think having messed up documentation showing up
on the website for a few days is necessarily a big deal, but we
should probably not ship that as part of a release.
--
Andrea Bolognani / Red Hat / Virtualization