[libvirt PATCH] include: Fix documentation for various VIR_*_LAST values

Andrea Bolognani posted 1 patch 2 years, 2 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20220127144456.35346-1-abologna@redhat.com
include/libvirt/libvirt-domain.h | 6 +++---
include/libvirt/libvirt-secret.h | 6 +++---
2 files changed, 6 insertions(+), 6 deletions(-)
[libvirt PATCH] include: Fix documentation for various VIR_*_LAST values
Posted by Andrea Bolognani 2 years, 2 months ago
Signed-off-by: Andrea Bolognani <abologna@redhat.com>
---
 include/libvirt/libvirt-domain.h | 6 +++---
 include/libvirt/libvirt-secret.h | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 4da1a63a14..374859fdff 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -62,7 +62,7 @@ typedef enum {
 # ifdef VIR_ENUM_SENTINELS
     VIR_DOMAIN_LAST
     /*
-     * NB: this enum value will increase over time as new events are
+     * NB: this enum value will increase over time as new states are
      * added to the libvirt API. It reflects the last state supported
      * by this version of the libvirt API.
      */
@@ -696,7 +696,7 @@ typedef enum {
     VIR_DOMAIN_CORE_DUMP_FORMAT_LAST
     /*
      * NB: this enum value will increase over time as new formats are
-     * added to the libvirt API. It reflects the last state supported
+     * added to the libvirt API. It reflects the last format supported
      * by this version of the libvirt API.
      */
 # endif
@@ -2909,7 +2909,7 @@ typedef enum {
 # ifdef VIR_ENUM_SENTINELS
     VIR_KEYCODE_SET_LAST
     /*
-     * NB: this enum value will increase over time as new events are
+     * NB: this enum value will increase over time as new keycode sets are
      * added to the libvirt API. It reflects the last keycode set supported
      * by this version of the libvirt API.
      */
diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h
index a75abc832a..82e18b8611 100644
--- a/include/libvirt/libvirt-secret.h
+++ b/include/libvirt/libvirt-secret.h
@@ -48,9 +48,9 @@ typedef enum {
 # ifdef VIR_ENUM_SENTINELS
     VIR_SECRET_USAGE_TYPE_LAST
     /*
-     * NB: this enum value will increase over time as new events are
-     * added to the libvirt API. It reflects the last secret owner ID
-     * supported by this version of the libvirt API.
+     * NB: this enum value will increase over time as new usage types are
+     * added to the libvirt API. It reflects the last usage type supported
+     * by this version of the libvirt API.
      */
 # endif
 } virSecretUsageType;
-- 
2.34.1

Re: [libvirt PATCH] include: Fix documentation for various VIR_*_LAST values
Posted by Ján Tomko 2 years, 2 months ago
On a Thursday in 2022, Andrea Bolognani wrote:
>Signed-off-by: Andrea Bolognani <abologna@redhat.com>
>---
> include/libvirt/libvirt-domain.h | 6 +++---
> include/libvirt/libvirt-secret.h | 6 +++---
> 2 files changed, 6 insertions(+), 6 deletions(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano