glusterd/cli: Updated the options descriptions for "volume set help"

Change-Id: I0db00b7334bb9707ab48bd661ac03a3ad818d6e4
BUG: 893458
Signed-off-by: Avra Sengupta <asengupt@redhat.com>
Reviewed-on: http://review.gluster.org/4393
Tested-by: Gluster Build System <jenkins@build.gluster.com>
Reviewed-by: Anand Avati <avati@redhat.com>

6 files changed, 71 insertions, 39 deletions

diff --git a/xlators/cluster/dht/src/dht.c b/xlators/cluster/dht/src/dht.c
index d70d713ac71..bb4d70ec8a3 100644
--- a/xlators/cluster/dht/src/dht.c
+++ b/xlators/cluster/dht/src/dht.c
@@ -578,18 +578,23 @@ struct volume_options options[] = {
                     "on", "off"},
           .type = GF_OPTION_TYPE_STR,
           .default_value = "on",
+          .description = "This option if set to ON, does a lookup through "
+          "all the sub-volumes, in case a lookup didn't return any result "
+          "from the hash subvolume. If set to OFF, it does not do a lookup "
+          "on the remaining subvolumes."
         },
         { .key  = {"min-free-disk"},
           .type = GF_OPTION_TYPE_PERCENT_OR_SIZET,
           .default_value = "10%",
-          .description = "Percentage/Size of disk space that must be "
-                         "kept free."
+          .description = "Percentage/Size of disk space, after which the "
+          "process starts balancing out the cluster, and logs will appear "
+          "in log files",
         },
 	{ .key  = {"min-free-inodes"},
           .type = GF_OPTION_TYPE_PERCENT,
           .default_value = "5%",
-          .description = "Percentage inodes that must be "
-                         "kept free."
+          .description = "after system has only N% of inodes, warnings "
+          "starts to appear in log files",
         },
         { .key = {"unhashed-sticky-bit"},
           .type = GF_OPTION_TYPE_BOOL,
@@ -598,16 +603,24 @@ struct volume_options options[] = {
         { .key = {"use-readdirp"},
           .type = GF_OPTION_TYPE_BOOL,
           .default_value = "on",
+          .description = "This option if set to ON, forces the use of "
+          "readdirp, and hence also displays the stats of the files."
         },
         { .key = {"assert-no-child-down"},
           .type = GF_OPTION_TYPE_BOOL,
           .default_value = "off",
+          .description = "This option if set to ON, in the event of "
+          "CHILD_DOWN, will call exit."
         },
         { .key  = {"directory-layout-spread"},
           .type = GF_OPTION_TYPE_INT,
+          .description = "Specifies the directory layout spread."
         },
         { .key  = {"decommissioned-bricks"},
           .type = GF_OPTION_TYPE_ANY,
+          .description = "This option if set to ON, decommissions "
+          "the brick, so that no new data is allowed to be created "
+          "on that brick."
         },
         { .key  = {"rebalance-cmd"},
           .type = GF_OPTION_TYPE_INT,
@@ -618,10 +631,17 @@ struct volume_options options[] = {
         { .key = {"rebalance-stats"},
           .type = GF_OPTION_TYPE_BOOL,
           .default_value = "off",
+          .description = "This option if set to ON displays and logs the "
+          " time taken for migration of each file, during the rebalance "
+          "process. If set to OFF, the rebalance logs will only display the "
+          "time spent in each directory."
         },
         { .key = {"readdir-optimize"},
           .type = GF_OPTION_TYPE_BOOL,
           .default_value = "off",
+          .description = "This option if set to ON enables the optimization "
+          "that allows DHT to requests non-first subvolumes to filter out "
+          "directory entries."
         },
 
         { .key  = {NULL} },
diff --git a/xlators/mgmt/glusterd/src/glusterd-volgen.c b/xlators/mgmt/glusterd/src/glusterd-volgen.c
index 521826aa578..119dcafe771 100644
--- a/xlators/mgmt/glusterd/src/glusterd-volgen.c
+++ b/xlators/mgmt/glusterd/src/glusterd-volgen.c
@@ -102,31 +102,31 @@
 
 static struct volopt_map_entry glusterd_volopt_map[] = {
         /* DHT xlator options */
-        {"cluster.lookup-unhashed",              "cluster/distribute", NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.min-free-disk",                "cluster/distribute", NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.min-free-inodes",              "cluster/distribute", NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.rebalance-stats",              "cluster/distribute", NULL, NULL, NO_DOC, 0, 2},
-        {"cluster.subvols-per-directory",        "cluster/distribute", "directory-layout-spread", NULL, NO_DOC, 0, 2},
-        {"cluster.readdir-optimize",             "cluster/distribute", NULL, NULL, NO_DOC, 0, 2},
+        {"cluster.lookup-unhashed",              "cluster/distribute", NULL, NULL, DOC, 0, 1},
+        {"cluster.min-free-disk",                "cluster/distribute", NULL, NULL, DOC, 0, 1},
+        {"cluster.min-free-inodes",              "cluster/distribute", NULL, NULL, DOC, 0, 1},
+        {"cluster.rebalance-stats",              "cluster/distribute", NULL, NULL, DOC, 0, 2},
+        {"cluster.subvols-per-directory",        "cluster/distribute", "directory-layout-spread", NULL, DOC, 0, 2},
+        {"cluster.readdir-optimize",             "cluster/distribute", NULL, NULL, DOC, 0, 2},
         {"cluster.nufa",                         "cluster/distribute", "!nufa", NULL, NO_DOC, 0, 2},
 
         /* AFR xlator options */
-        {"cluster.entry-change-log",             "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.read-subvolume",               "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.read-subvolume-index",         "cluster/replicate",  NULL, NULL, NO_DOC, 0, 2},
-        {"cluster.read-hash-mode",               "cluster/replicate",  NULL, NULL, NO_DOC, 0, 2},
-        {"cluster.background-self-heal-count",   "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.metadata-self-heal",           "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.data-self-heal",               "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.entry-self-heal",              "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.self-heal-daemon",             "cluster/replicate",  "!self-heal-daemon" , NULL, NO_DOC, 0, 1},
-        {"cluster.heal-timeout",                 "cluster/replicate",  "!heal-timeout" , NULL, NO_DOC, 0, 2},
+        {"cluster.entry-change-log",             "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.read-subvolume",               "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.read-subvolume-index",         "cluster/replicate",  NULL, NULL, DOC, 0, 2},
+        {"cluster.read-hash-mode",               "cluster/replicate",  NULL, NULL, DOC, 0, 2},
+        {"cluster.background-self-heal-count",   "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.metadata-self-heal",           "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.data-self-heal",               "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.entry-self-heal",              "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.self-heal-daemon",             "cluster/replicate",  "!self-heal-daemon" , NULL, DOC, 0, 1},
+        {"cluster.heal-timeout",                 "cluster/replicate",  "!heal-timeout" , NULL, DOC, 0, 2},
         {"cluster.strict-readdir",               "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
         {"cluster.self-heal-window-size",        "cluster/replicate",  "data-self-heal-window-size", NULL, DOC, 0, 1},
-        {"cluster.data-change-log",              "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
-        {"cluster.metadata-change-log",          "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
+        {"cluster.data-change-log",              "cluster/replicate",  NULL, NULL, DOC, 0, 1},
+        {"cluster.metadata-change-log",          "cluster/replicate",  NULL, NULL, DOC, 0, 1},
         {"cluster.data-self-heal-algorithm",     "cluster/replicate",  "data-self-heal-algorithm", NULL, DOC, 0, 1},
-        {"cluster.eager-lock",                   "cluster/replicate",  NULL, NULL, NO_DOC, 0, 1},
+        {"cluster.eager-lock",                   "cluster/replicate",  NULL, NULL, DOC, 0, 1},
         {"cluster.quorum-type",                  "cluster/replicate",  "quorum-type", NULL, DOC, 0, 1},
         {"cluster.quorum-count",                 "cluster/replicate",  "quorum-count", NULL, DOC, 0, 1},
         {"cluster.choose-local",                 "cluster/replicate",  NULL, NULL, DOC, 0, 2},
@@ -138,8 +138,8 @@ static struct volopt_map_entry glusterd_volopt_map[] = {
 	{"cluster.stripe-coalesce",		 "cluster/stripe",     "coalesce", NULL, DOC, 0, 2},
 
         /* IO-stats xlator options */
-        {VKEY_DIAG_LAT_MEASUREMENT,              "debug/io-stats",     "latency-measurement", "off", NO_DOC, 0, 1},
-        {"diagnostics.dump-fd-stats",            "debug/io-stats",     NULL, NULL, NO_DOC, 0, 1},
+        {VKEY_DIAG_LAT_MEASUREMENT,              "debug/io-stats",     "latency-measurement", "off", DOC, 0, 1},
+        {"diagnostics.dump-fd-stats",            "debug/io-stats",     NULL, NULL, DOC, 0, 1},
         {VKEY_DIAG_CNT_FOP_HITS,                 "debug/io-stats",     "count-fop-hits", "off", NO_DOC, 0, 1},
         {"diagnostics.brick-log-level",          "debug/io-stats",     "!brick-log-level", NULL, DOC, 0, 1},
         {"diagnostics.client-log-level",         "debug/io-stats",     "!client-log-level", NULL, DOC, 0, 1},
@@ -151,7 +151,7 @@ static struct volopt_map_entry glusterd_volopt_map[] = {
         {"performance.cache-min-file-size",      "performance/io-cache",      "min-file-size", NULL, DOC, 0, 1},
         {"performance.cache-refresh-timeout",    "performance/io-cache",      "cache-timeout", NULL, DOC, 0, 1},
         {"performance.cache-priority",           "performance/io-cache",      "priority", NULL, DOC, 0, 1},
-        {"performance.cache-size",               "performance/io-cache",      NULL, NULL, NO_DOC, 0, 1},
+        {"performance.cache-size",               "performance/io-cache",      NULL, NULL, DOC, 0, 1},
 
         /* IO-threads xlator options */
         {"performance.io-thread-count",          "performance/io-threads",    "thread-count", NULL, DOC, 0, 1},
@@ -163,7 +163,7 @@ static struct volopt_map_entry glusterd_volopt_map[] = {
 	{"performance.least-rate-limit",	 "performance/io-threads",    NULL, NULL, DOC, 0, 1},
 
         /* Other perf xlators' options */
-        {"performance.cache-size",               "performance/quick-read",    NULL, NULL, NO_DOC, 0, 1},
+        {"performance.cache-size",               "performance/quick-read",    NULL, NULL, DOC, 0, 1},
 
         {"performance.flush-behind",             "performance/write-behind",  "flush-behind", NULL, DOC, 0, 1},
         {"performance.write-behind-window-size", "performance/write-behind",  "cache-size", NULL, DOC, 1},
@@ -174,17 +174,17 @@ static struct volopt_map_entry glusterd_volopt_map[] = {
         {"performance.md-cache-timeout",         "performance/md-cache",      "md-cache-timeout", NULL, DOC, 0, 2},
 
         /* Client xlator options */
-        {"network.frame-timeout",                "protocol/client",           NULL, NULL, NO_DOC, 0, 1},
-        {"network.ping-timeout",                 "protocol/client",           NULL, NULL, NO_DOC, 0, 1},
-        {"network.tcp-window-size",              "protocol/client",           NULL, NULL, NO_DOC, 0, 1},
+        {"network.frame-timeout",                "protocol/client",           NULL, NULL, DOC, 0, 1},
+        {"network.ping-timeout",                 "protocol/client",           NULL, NULL, DOC, 0, 1},
+        {"network.tcp-window-size",              "protocol/client",           NULL, NULL, DOC, 0, 1},
         {"features.lock-heal",                   "protocol/client",           "lk-heal", NULL, DOC, 0, 1},
         {"features.grace-timeout",               "protocol/client",           "grace-timeout", NULL, DOC, 0, 1},
         {"client.ssl",                           "protocol/client",           "transport.socket.ssl-enabled", NULL, NO_DOC, 0, 2},
         {"network.remote-dio",                   "protocol/client",           "filter-O_DIRECT", NULL, DOC, 0, 1},
 
         /* Server xlator options */
-        {"network.tcp-window-size",              "protocol/server",           NULL, NULL, NO_DOC, 0, 1},
-        {"network.inode-lru-limit",              "protocol/server",           NULL, NULL, NO_DOC, 0, 1},
+        {"network.tcp-window-size",              "protocol/server",           NULL, NULL, DOC, 0, 1},
+        {"network.inode-lru-limit",              "protocol/server",           NULL, NULL, DOC, 0, 1},
         {AUTH_ALLOW_MAP_KEY,                     "protocol/server",           "!server-auth", "*", DOC, 0, 1},
         {AUTH_REJECT_MAP_KEY,                    "protocol/server",           "!server-auth", NULL, DOC, 0},
 
@@ -233,7 +233,7 @@ static struct volopt_map_entry glusterd_volopt_map[] = {
         {"nfs.export-dirs",                      "nfs/server",                "nfs3.export-dirs", NULL, GLOBAL_DOC, 0, 1},
         {"nfs.export-volumes",                   "nfs/server",                "nfs3.export-volumes", NULL, GLOBAL_DOC, 0, 1},
         {"nfs.addr-namelookup",                  "nfs/server",                "rpc-auth.addr.namelookup", NULL, GLOBAL_DOC, 0, 1},
-        {"nfs.dynamic-volumes",                  "nfs/server",                "nfs.dynamic-volumes", NULL, GLOBAL_NO_DOC, 0, 1},
+        {"nfs.dynamic-volumes",                  "nfs/server",                "nfs.dynamic-volumes", NULL, GLOBAL_DOC, 0, 1},
         {"nfs.register-with-portmap",            "nfs/server",                "rpc.register-with-portmap", NULL, GLOBAL_DOC, 0, 1},
         {"nfs.port",                             "nfs/server",                "nfs.port", NULL, GLOBAL_DOC, 0, 1},
         {"nfs.rpc-auth-unix",                    "nfs/server",                "!rpc-auth.auth-unix.*", NULL, DOC, 0, 1},
@@ -2122,9 +2122,9 @@ glusterd_get_volopt_content (dict_t * ctx, gf_boolean_t xml_out)
         int                      ret = -1;
         char                    *def_val = NULL;
         char                    *descr = NULL;
-        char                     output_string[16384] = {0, };
+        char                     output_string[25600] = {0, };
         char                    *output = NULL;
-        char                     tmp_str[1024] = {0, };
+        char                     tmp_str[2048] = {0, };
 #if (HAVE_LIB_XML)
         xmlTextWriterPtr         writer = NULL;
         xmlBufferPtr             buf = NULL;
@@ -2170,7 +2170,7 @@ glusterd_get_volopt_content (dict_t * ctx, gf_boolean_t xml_out)
                         gf_log ("glusterd", GF_LOG_ERROR, "Libxml not present");
 #endif
                 } else {
-                        snprintf (tmp_str, 1024, "Option: %s\nDefault "
+                        snprintf (tmp_str, 2048, "Option: %s\nDefault "
                                         "Value: %s\nDescription: %s\n\n",
                                         vme->key, def_val, descr);
                         strcat (output_string, tmp_str);
diff --git a/xlators/mgmt/glusterd/src/glusterd.c b/xlators/mgmt/glusterd/src/glusterd.c
index 644c837aca4..cde6c84fee6 100644
--- a/xlators/mgmt/glusterd/src/glusterd.c
+++ b/xlators/mgmt/glusterd/src/glusterd.c
@@ -1268,9 +1268,13 @@ struct volume_options options[] = {
         { .key = {"server-quorum-type"},
           .type = GF_OPTION_TYPE_STR,
           .value = { "none", "server"},
+          .description = "If set to server, enables the specified "
+          "volume to participate in quorum."
         },
         { .key = {"server-quorum-ratio"},
           .type = GF_OPTION_TYPE_PERCENT,
+          .description = "Sets the quorum percentage for the trusted "
+          "storage pool."
         },
         { .key   = {NULL} },
 };
diff --git a/xlators/performance/write-behind/src/write-behind.c b/xlators/performance/write-behind/src/write-behind.c
index a256419e867..0663dbc7de0 100644
--- a/xlators/performance/write-behind/src/write-behind.c
+++ b/xlators/performance/write-behind/src/write-behind.c
@@ -1987,6 +1987,8 @@ struct volume_options options[] = {
         { .key = {"strict-O_DIRECT"},
           .type = GF_OPTION_TYPE_BOOL,
           .default_value = "off",
+          .description = "This option when set to off, ignores the "
+          "O_DIRECT flag."
         },
         { .key = {"strict-write-ordering"},
           .type = GF_OPTION_TYPE_BOOL,
diff --git a/xlators/protocol/client/src/client.c b/xlators/protocol/client/src/client.c
index 46fe622db58..931c67156fb 100644
--- a/xlators/protocol/client/src/client.c
+++ b/xlators/protocol/client/src/client.c
@@ -2720,16 +2720,19 @@ struct volume_options options[] = {
         { .key   = {"lk-heal"},
           .type  = GF_OPTION_TYPE_BOOL,
           .default_value = "off",
+          .description = "Enables or disables the lock heal."
         },
         { .key   = {"grace-timeout"},
           .type  = GF_OPTION_TYPE_INT,
           .min   = 10,
-          .max   = 1800
+          .max   = 1800,
+          .description = "Sets the grace-timeout value. Valid range 10-1800."
         },
         {.key  = {"tcp-window-size"},
          .type = GF_OPTION_TYPE_SIZET,
          .min  = GF_MIN_SOCKET_WINDOW_SIZE,
-         .max  = GF_MAX_SOCKET_WINDOW_SIZE
+         .max  = GF_MAX_SOCKET_WINDOW_SIZE,
+         .description = "Specifies the window size for tcp socket."
         },
         { .key   = {"filter-O_DIRECT"},
           .type  = GF_OPTION_TYPE_BOOL,
diff --git a/xlators/protocol/server/src/server.c b/xlators/protocol/server/src/server.c
index cdf421ddda6..5cc27ce60e9 100644
--- a/xlators/protocol/server/src/server.c
+++ b/xlators/protocol/server/src/server.c
@@ -1258,6 +1258,8 @@ struct volume_options options[] = {
           .min   = 0,
           .max   = (1 * GF_UNIT_MB),
           .default_value = "16384",
+          .description = "Specifies the maximum megabytes of memory to be "
+          "used in the inode cache."
         },
         { .key   = {"verify-volfile-checksum"},
           .type  = GF_OPTION_TYPE_BOOL
@@ -1290,7 +1292,8 @@ struct volume_options options[] = {
         {.key  = {"tcp-window-size"},
          .type = GF_OPTION_TYPE_SIZET,
          .min  = GF_MIN_SOCKET_WINDOW_SIZE,
-         .max  = GF_MAX_SOCKET_WINDOW_SIZE
+         .max  = GF_MAX_SOCKET_WINDOW_SIZE,
+         .description = "Specifies the window size for tcp socket."
         },
 
         /*  The following two options are defined in addr.c, redifined here *