[PATCH v3 18/30] docstring: Fix generated documentation of virStorageVolInfoFlags

Victor Toso victortoso at redhat.com
Wed Apr 20 19:08:07 UTC 2022


This commit is similar to "docs: Fix generated documentation of
virConnectListAllNodeDeviceFlags", check it out for more info.

Using git diff --word-diff to show the fixed output xml (redacted).

  <enum name='VIR_STORAGE_VOL_GET_PHYSICAL' ...
    [-type='virStorageVolInfoFlags'/>-]
    {+type='virStorageVolInfoFlags' version='3.0.0' info='Return the physical size in allocation'/>+}
  ...
  <enum name='VIR_STORAGE_VOL_USE_ALLOCATION' ... type='virStorageVolInfoFlags'
    [-info='Return the physical size in allocation'/>-]
    {+version='3.0.0'/>+}

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

diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h
index 434454f455..8b57b1f2e8 100644
--- a/include/libvirt/libvirt-storage.h
+++ b/include/libvirt/libvirt-storage.h
@@ -248,11 +248,8 @@ typedef enum {
  *
  */
 typedef enum {
-    VIR_STORAGE_VOL_USE_ALLOCATION = 0,
-
-    /* Return the physical size in allocation */
-    VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0,
-
+    VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: v3.0.0) */
+    VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: v3.0.0) */
 } virStorageVolInfoFlags;
 
 /**
-- 
2.35.1



More information about the libvir-list mailing list