From: Michael Meffie <mmeffie@sinenomine.net>
Date: Fri, 4 Apr 2014 14:14:15 +0000 (-0400)
Subject: cmd: avoid piggy-backing flags in the help string
X-Git-Tag: openafs-stable-1_8_0pre1~473
X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=3b8c4abf81ea90e7f24fb7d729062ebb0753043d

cmd: avoid piggy-backing flags in the help string

Remove the hack to piggy-back the hidden command option
in the help string argument.

Change-Id: Iedcb6b96e98b766e3ef2c87cd6e5d41874f2c0b7
Reviewed-on: http://gerrit.openafs.org/10982
Reviewed-by: D Brashear <shadow@your-file-system.com>
Reviewed-by: Chas Williams - CONTRACTOR <chas@cmf.nrl.navy.mil>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
---

diff --git a/src/WINNT/afsd/fs.c b/src/WINNT/afsd/fs.c
index 8f27a42..f77033d 100644
--- a/src/WINNT/afsd/fs.c
+++ b/src/WINNT/afsd/fs.c
@@ -5448,7 +5448,7 @@ int wmain(int argc, wchar_t **wargv)
 
     ts = cmd_CreateSyntax("minidump", MiniDumpCmd, NULL, 0, "Generate MiniDump of current service state");
 
-    ts = cmd_CreateSyntax("test_volstat", TestVolStatCmd, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("test_volstat", TestVolStatCmd, NULL, CMD_HIDDEN, "check or update volume state");
     cmd_AddParm(ts, "-network", CMD_SINGLE, CMD_OPTIONAL, "set network state up or down");
     cmd_AddParm(ts, "-check",   CMD_FLAG,   CMD_OPTIONAL, "check state of offline volumes");
     cmd_AddParm(ts, "-cell",    CMD_SINGLE, CMD_OPTIONAL, "cell name or number");
diff --git a/src/cmd/cmd.c b/src/cmd/cmd.c
index cff5731..f97e558 100644
--- a/src/cmd/cmd.c
+++ b/src/cmd/cmd.c
@@ -477,13 +477,8 @@ cmd_CreateSyntax(char *aname,
 	noOpcodes = 1;
     }
     if (ahelp) {
-	/* Piggy-back the hidden option onto the help string. */
-	if (ahelp == (char *)CMD_HIDDEN) {
-	    td->flags |= CMD_HIDDEN;
-	} else {
-	    td->help = strdup(ahelp);
-	    assert(td->help);
-	}
+	td->help = strdup(ahelp);
+	assert(td->help);
     } else
 	td->help = NULL;
     td->proc = aproc;
@@ -781,14 +776,10 @@ initSyntax(void)
 
 	cmd_CreateSyntax("version", VersionProc, NULL, 0,
 			 "show version");
-	cmd_CreateSyntax("-version", VersionProc, NULL, 0,
-			 (char *)CMD_HIDDEN);
-	cmd_CreateSyntax("-help", HelpProc, NULL, 0,
-			 (char *)CMD_HIDDEN);
-	cmd_CreateSyntax("--version", VersionProc, NULL, 0,
-		         (char *)CMD_HIDDEN);
-	cmd_CreateSyntax("--help", HelpProc, NULL, 0,
-			 (char *)CMD_HIDDEN);
+	cmd_CreateSyntax("-version", VersionProc, NULL, CMD_HIDDEN, NULL);
+	cmd_CreateSyntax("-help", HelpProc, NULL, CMD_HIDDEN, NULL);
+	cmd_CreateSyntax("--version", VersionProc, NULL, CMD_HIDDEN, NULL);
+	cmd_CreateSyntax("--help", HelpProc, NULL, CMD_HIDDEN, NULL);
     }
 }
 
diff --git a/src/kauth/admin_tools.c b/src/kauth/admin_tools.c
index 579e97f..14706e9 100644
--- a/src/kauth/admin_tools.c
+++ b/src/kauth/admin_tools.c
@@ -1751,8 +1751,7 @@ ka_AdminInteractive(int cmd_argc, char *cmd_argv[])
     cmd_CreateAlias(ts, "setpasswd");
 #endif
 
-    /* set a user's key */
-    ts = cmd_CreateSyntax("setkey", SetPassword, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("setkey", SetPassword, NULL, CMD_HIDDEN, "set a user's key");
     cmd_AddParm(ts, "-name", CMD_SINGLE, 0, "name of user");
     cmd_Seek(ts, 2);
     cmd_AddParm(ts, "-new_key", CMD_SINGLE, 0, "eight byte new key");
@@ -1760,8 +1759,7 @@ ka_AdminInteractive(int cmd_argc, char *cmd_argv[])
     cmd_AddParm(ts, "-kvno", CMD_SINGLE, CMD_OPTIONAL, "key version number");
     add_std_args(ts);
 
-    /* get a user's password */
-    ts = cmd_CreateSyntax("getpassword", GetPassword, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("getpassword", GetPassword, NULL, CMD_HIDDEN, "get a user's password");
     cmd_AddParm(ts, "-name", CMD_SINGLE, 0, "name of user");
     /* don't take standard args */
     /* add_std_args (ts); */
@@ -1769,13 +1767,10 @@ ka_AdminInteractive(int cmd_argc, char *cmd_argv[])
     cmd_CreateAlias(ts, "getpasswd");
 #endif
 
-    /* get a random key */
-    ts = cmd_CreateSyntax("getrandomkey", GetRandomKey, NULL, 0,
-			  (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("getrandomkey", GetRandomKey, NULL, CMD_HIDDEN, "get a random key");
     add_std_args(ts);
 
-    /* get a ticket for a specific server */
-    ts = cmd_CreateSyntax("getticket", GetTicket, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("getticket", GetTicket, NULL, CMD_HIDDEN, "get a ticket for a specific server");
     cmd_AddParm(ts, "-name", CMD_SINGLE, 0, "name of server");
     cmd_AddParm(ts, "-lifetime", CMD_SINGLE, CMD_OPTIONAL, "ticket lifetime");
     add_std_args(ts);
@@ -1784,8 +1779,7 @@ ka_AdminInteractive(int cmd_argc, char *cmd_argv[])
 			  "show statistics for AuthServer");
     add_std_args(ts);
 
-    /* show debugging info from AuthServer */
-    ts = cmd_CreateSyntax("debuginfo", DebugInfo, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("debuginfo", DebugInfo, NULL, CMD_HIDDEN, "show debugging info from AuthServer");
     cmd_AddParm(ts, "-hostname", CMD_SINGLE, CMD_OPTIONAL,
 		"authentication server host name");
     add_std_args(ts);
diff --git a/src/venus/fs.c b/src/venus/fs.c
index e4712ff..caf7ce3 100644
--- a/src/venus/fs.c
+++ b/src/venus/fs.c
@@ -3873,8 +3873,7 @@ defect 3069
     ts = cmd_CreateSyntax("primarycell", PrimaryCellCmd, NULL, "obsolete (listed primary cell)");
 */
 
-    /* set cache monitor host address */
-    ts = cmd_CreateSyntax("monitor", MonitorCmd, NULL, 0, (char *)CMD_HIDDEN);
+    ts = cmd_CreateSyntax("monitor", MonitorCmd, NULL, CMD_HIDDEN, "set cache monitor host address");
     cmd_AddParm(ts, "-server", CMD_SINGLE, CMD_OPTIONAL,
 		"host name or 'off'");
     cmd_CreateAlias(ts, "mariner");