[PATCH v3 20/30] docstring: Fix and append Since to virDomainDeviceModifyFlags
Victor Toso
victortoso at redhat.com
Thu Apr 21 18:39:56 UTC 2022
Hi,
On Thu, Apr 21, 2022 at 03:52:58PM +0200, Peter Krempa wrote:
> On Thu, Apr 21, 2022 at 15:51:25 +0200, Peter Krempa wrote:
> > On Wed, Apr 20, 2022 at 21:08:09 +0200, Victor Toso wrote:
> > > This commit is similar to "docs: Fix generated documentation of
> > > virConnectListAllNodeDeviceFlags", check it out for more info.
> > >
> > > Signed-off-by: Victor Toso <victortoso at redhat.com>
> > > ---
> > > include/libvirt/libvirt-domain.h | 14 +++++++-------
> > > 1 file changed, 7 insertions(+), 7 deletions(-)
> > >
> > > diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
> > > index 9199cc9ad3..27a680a907 100644
> > > --- a/include/libvirt/libvirt-domain.h
> > > +++ b/include/libvirt/libvirt-domain.h
> > > @@ -2758,18 +2758,18 @@ int virDomainGetVcpus (virDomainPtr domain,
> > > /**
> > > * virDomainDeviceModifyFlags:
> > > *
> > > - * Since: v1.0.0
> > > + * These flags may be bitwise-OR'd in.
> > > + *
> > > + * Since: v0.7.7
> > > *
> > > */
> > > typedef enum {
> > > - /* See virDomainModificationImpact for these flags. (Since: v1.0.0) */
> > > - VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
> > > - VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE,
> > > - VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG,
> > > + VIR_DOMAIN_DEVICE_MODIFY_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.7.7) */
> > > + VIR_DOMAIN_DEVICE_MODIFY_LIVE = VIR_DOMAIN_AFFECT_LIVE, /* (Since: v0.7.7) */
> > > + VIR_DOMAIN_DEVICE_MODIFY_CONFIG = VIR_DOMAIN_AFFECT_CONFIG, /* (Since: v0.7.7) */
> > >
> > > - /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0) */
> > > VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device
> > > - (ex. force eject a cdrom) */
> > > + (ex. force eject a cdrom) (Since: v0.8.6) */
> > > } virDomainDeviceModifyFlags;
> >
> > This one has a lot of weird 'Since' tags.
>
> I'm unsure how to get about this. Either squash this to the appropriate
> commit or perhaps remove the comments breaking stuff before and then
> just apply the numbers along in the patch doing everything else.
Yes, that was my bad. I realized the issue with the typedef but
only after running the script. I should done it in the right
order.
Sorry about that.
Victor
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20220421/2fb4a890/attachment.sig>
More information about the libvir-list
mailing list