[PATCH v4 05/19] docstring: remove comments between enum values

Victor Toso victortoso at redhat.com
Fri Apr 22 19:23:30 UTC 2022


scripts/apibuild.py does not handle well enum's with comments between
values. The outcome depends on whether the enum value has its own
docstring or not and if there is spaces between the enum values or
not.

This commit removes some generic comments that I have spotted.

Signed-off-by: Victor Toso <victortoso at redhat.com>
---
 include/libvirt/libvirt-domain.h  | 6 ------
 include/libvirt/libvirt-storage.h | 1 -
 2 files changed, 7 deletions(-)

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 138133b719..0fa4509b73 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -1758,12 +1758,10 @@ int     virDomainGetMemoryParameters(virDomainPtr domain,
  * Since: v0.9.0
  */
 typedef enum {
-    /* See virDomainModificationImpact for these flags.  */
     VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
     VIR_DOMAIN_MEM_LIVE    = VIR_DOMAIN_AFFECT_LIVE,
     VIR_DOMAIN_MEM_CONFIG  = VIR_DOMAIN_AFFECT_CONFIG,
 
-    /* Additionally, these flags may be bitwise-OR'd in.  */
     VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current */
 } virDomainMemoryModFlags;
 
@@ -2267,12 +2265,10 @@ typedef virVcpuInfo *virVcpuInfoPtr;
  * Since: v0.8.5
  */
 typedef enum {
-    /* See virDomainModificationImpact for these flags.  */
     VIR_DOMAIN_VCPU_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
     VIR_DOMAIN_VCPU_LIVE    = VIR_DOMAIN_AFFECT_LIVE,
     VIR_DOMAIN_VCPU_CONFIG  = VIR_DOMAIN_AFFECT_CONFIG,
 
-    /* Additionally, these flags may be bitwise-OR'd in.  */
     VIR_DOMAIN_VCPU_MAXIMUM = (1 << 2), /* Max rather than current count */
     VIR_DOMAIN_VCPU_GUEST   = (1 << 3), /* Modify state of the cpu in the guest */
     VIR_DOMAIN_VCPU_HOTPLUGGABLE = (1 << 4), /* Make vcpus added hot(un)pluggable */
@@ -2514,12 +2510,10 @@ int                     virDomainGetVcpus       (virDomainPtr domain,
  * Since: v0.7.7
  */
 typedef enum {
-    /* See virDomainModificationImpact for these flags.  */
     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,
 
-    /* Additionally, these flags may be bitwise-OR'd in.  */
     VIR_DOMAIN_DEVICE_MODIFY_FORCE = (1 << 2), /* Forcibly modify device
                                                   (ex. force eject a cdrom) */
 } virDomainDeviceModifyFlags;
diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h
index 94802bb2c5..46803eba2d 100644
--- a/include/libvirt/libvirt-storage.h
+++ b/include/libvirt/libvirt-storage.h
@@ -304,7 +304,6 @@ typedef enum {
     VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART     = 1 << 4,
     VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART  = 1 << 5,
 
-    /* List pools by type */
     VIR_CONNECT_LIST_STORAGE_POOLS_DIR           = 1 << 6,
     VIR_CONNECT_LIST_STORAGE_POOLS_FS            = 1 << 7,
     VIR_CONNECT_LIST_STORAGE_POOLS_NETFS         = 1 << 8,
-- 
2.35.1



More information about the libvir-list mailing list