[PATCH] Update comments for the memory tunables macros

["Nikunj A. Dadhania" <nikunj@xxxxxxxxxxxxxxxxxx>]

From: Nikunj A. Dadhania <nikunj@xxxxxxxxxxxxxxxxxx>

include/libvirt/libvirt.h.in: Update comment with actual description

Signed-off-by: Nikunj A. Dadhania <nikunj@xxxxxxxxxxxxxxxxxx>
---
 include/libvirt/libvirt.h.in |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
index ca8e6fa..1b9874e 100644
--- a/include/libvirt/libvirt.h.in
+++ b/include/libvirt/libvirt.h.in
@@ -699,7 +699,8 @@ typedef enum {
 /**
  * VIR_DOMAIN_MEMORY_HARD_LIMIT:
  *
- * Macro for the well-known tunable hard_limit.
+ * Macro for the memory tunable hard_limit: it represents the maximum memory
+ * the guest can use.
  */
 
 #define VIR_DOMAIN_MEMORY_HARD_LIMIT "hard_limit"
@@ -707,7 +708,8 @@ typedef enum {
 /**
  * VIR_DOMAIN_MEMORY_SOFT_LIMIT:
  *
- * Macro for the well-known tunable soft_limit.
+ * Macro for the memory tunable soft_limit: it represents the memory upper
+ * limit enforced during memory contention.
  */
 
 #define VIR_DOMAIN_MEMORY_SOFT_LIMIT "soft_limit"
@@ -715,7 +717,8 @@ typedef enum {
 /**
  * VIR_DOMAIN_MEMORY_MIN_GUARANTEE:
  *
- * Macro for the well-known tunable min_guarantee.
+ * Macro for the memory tunable min_guarantee: it represents the minimum
+ * memory guaranteed to be reserved for the guest.
  */
 
 #define VIR_DOMAIN_MEMORY_MIN_GUARANTEE "min_guarantee"
@@ -723,7 +726,8 @@ typedef enum {
 /**
  * VIR_DOMAIN_SWAP_HARD_LIMIT:
  *
- * Macro for the well-known tunable swap_hard_limit.
+ * Macro for the swap tunable swap_hard_limit: it represents the maximum swap
+ * the guest can use.
  */
 
 #define VIR_DOMAIN_SWAP_HARD_LIMIT "swap_hard_limit"

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list