From 6f86287aac50f0bddb1bd64ee12031289ab08ca6 Mon Sep 17 00:00:00 2001
From: Mohammed Rafi KC <rkavunga@redhat.com>
Date: Tue, 12 May 2015 14:50:33 +0530
Subject: [PATCH 127/129] tier/glusterd: Add description for volume set options

Backport of http://review.gluster.org/#/c/10757/

>>Change-Id: Idc2eed77f8d841b6628183867e84601ce605d610
>>BUG: 1215571
>>Signed-off-by: Mohammed Rafi KC <rkavunga@redhat.com>
>>Signed-off-by: Joseph Fernandes <josferna@redhat.com>
>>Reviewed-on: http://review.gluster.org/10757
>>Tested-by: NetBSD Build System <jenkins@build.gluster.org>
>>Reviewed-by: Dan Lambright <dlambrig@redhat.com>
Signed-off-by: Joseph Fernandes <josferna@redhat.com>

Change-Id: Id25ff82bc84c4c8c60f568ecf5846930fe86bd21
BUG: 1229260
Reviewed-on: https://code.engineering.redhat.com/gerrit/51204
Reviewed-by: Dan Lambright <dlambrig@redhat.com>
Tested-by: Dan Lambright <dlambrig@redhat.com>
---
 xlators/mgmt/glusterd/src/glusterd-volume-set.c |   38 ++++++++++++++++++----
 1 files changed, 31 insertions(+), 7 deletions(-)

diff --git a/xlators/mgmt/glusterd/src/glusterd-volume-set.c b/xlators/mgmt/glusterd/src/glusterd-volume-set.c
index 83256c4..af26584 100644
--- a/xlators/mgmt/glusterd/src/glusterd-volume-set.c
+++ b/xlators/mgmt/glusterd/src/glusterd-volume-set.c
@@ -1840,46 +1840,70 @@ struct volopt_map_entry glusterd_volopt_map[] = {
           .option      = "write-freq-threshold",
           .op_version  = GD_OP_VERSION_3_7_0,
           .flags       = OPT_FLAG_CLIENT_OPT,
-          .validate_fn = validate_tier
+          .validate_fn = validate_tier,
+          .description = "Defines the number of writes, in a promotion/demotion"
+                         " cycle, that would mark a file HOT for promotion. Any"
+                         " file that has write hits less than this value will "
+                         "be considered as COLD and will be demoted."
         },
         { .key         = "cluster.read-freq-threshold",
           .voltype     = "cluster/tier",
           .option      = "read-freq-threshold",
           .op_version  = GD_OP_VERSION_3_7_0,
           .flags       = OPT_FLAG_CLIENT_OPT,
-          .validate_fn = validate_tier
+          .validate_fn = validate_tier,
+          .description = "Defines the number of reads, in a promotion/demotion "
+                         "cycle, that would mark a file HOT for promotion. Any "
+                         "file that has read hits less than this value will be "
+                         "considered as COLD and will be demoted."
         },
         { .key         = "cluster.tier-promote-frequency",
           .voltype     = "cluster/tier",
           .option      = "tier-promote-frequency",
           .op_version  = GD_OP_VERSION_3_7_0,
           .flags       = OPT_FLAG_CLIENT_OPT,
-          .validate_fn = validate_tier
+          .validate_fn = validate_tier,
+          .description = "Defines how often the promotion should be triggered "
+                         "i.e. periodicity of promotion cycles. The value is in "
+                         "secs."
         },
         { .key         = "cluster.tier-demote-frequency",
           .voltype     = "cluster/tier",
           .option      = "tier-demote-frequency",
           .op_version  = GD_OP_VERSION_3_7_0,
           .flags       = OPT_FLAG_CLIENT_OPT,
-          .validate_fn = validate_tier
+          .validate_fn = validate_tier,
+          .description = "Defines how often the demotion should be triggered "
+                         "i.e. periodicity of demotion cycles. The value is in "
+                         "secs."
         },
         { .key         = "features.ctr-enabled",
           .voltype     = "features/changetimerecorder",
           .value       = "off",
           .option      = "ctr-enabled",
-          .op_version  = GD_OP_VERSION_3_7_0
+          .op_version  = GD_OP_VERSION_3_7_0,
+          .description = "Enable CTR xlator"
         },
         { .key         = "features.record-counters",
           .voltype     = "features/changetimerecorder",
           .value       = "off",
           .option      = "record-counters",
-          .op_version  = GD_OP_VERSION_3_7_0
+          .op_version  = GD_OP_VERSION_3_7_0,
+          .description = "Its a Change Time Recorder Xlator option to enable recording write "
+                         "and read heat counters. The default is disabled. "
+                         "If enabled, \"cluster.write-freq-threshold\" and "
+                         "\"cluster.read-freq-threshold\" defined the number "
+                         "of writes (or reads) to a given file are needed "
+                         "before triggering migration."
         },
         { .key         = "features.ctr_link_consistency",
           .voltype     = "features/changetimerecorder",
           .value       = "off",
           .option      = "ctr_link_consistency",
-          .op_version  = GD_OP_VERSION_3_7_0
+          .op_version  = GD_OP_VERSION_3_7_0,
+          .description = "Enable a crash consistent way of recording hardlink "
+                         "updates by Change Time Recorder Xlator. When recording in a crash "
+                         "consistent way the data operations will experience more latency."
         },
 #endif /* USE_GFDB */
         { .key         = "locks.trace",
-- 
1.7.1