doveadm: Define DOVEADM_CMD_MAIL_USAGE_PREFIX, which v2 commands use …

…as their usage prefix. This allows implementing the next changeset without kludging.
dovecot · Feb 22, 2016 · c45a841 · c45a841
1 parent 7a8ef11
commit c45a841
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 18 deletions.
diff --git a/src/doveadm/doveadm-mail-fetch.c b/src/doveadm/doveadm-mail-fetch.c
@@ -608,7 +608,7 @@ static struct doveadm_mail_cmd_context *cmd_fetch_alloc(void)
 struct doveadm_cmd_ver2 doveadm_cmd_fetch_ver2 = {
 	.name = "fetch",
 	.mail_cmd = cmd_fetch_alloc,
-	.usage = "<fields> <search query>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<fields> <search query>",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "field", CMD_PARAM_ARRAY, 0)

diff --git a/src/doveadm/doveadm-mail-index.c b/src/doveadm/doveadm-mail-index.c
@@ -276,7 +276,7 @@ static struct doveadm_mail_cmd_context *cmd_index_alloc(void)
 
 struct doveadm_cmd_ver2 doveadm_cmd_index_ver2 = {
 	.name = "index",
-	.usage = "[-q] [-n <max recent>] <mailbox mask>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-q] [-n <max recent>] <mailbox mask>",
 	.mail_cmd = cmd_index_alloc,
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON

diff --git a/src/doveadm/doveadm-mail-mailbox-metadata.c b/src/doveadm/doveadm-mail-mailbox-metadata.c
@@ -289,7 +289,7 @@ static struct doveadm_mail_cmd_context *cmd_mailbox_metadata_list_alloc(void)
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_metadata_set_ver2 = {
 	.name = "mailbox metadata set",
 	.mail_cmd = cmd_mailbox_metadata_set_alloc,
-	.usage = "<mailbox> <key> <value>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> <key> <value>",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "mailbox", CMD_PARAM_STR, CMD_PARAM_FLAG_POSITIONAL)
@@ -301,7 +301,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_metadata_unset_ver2 = {
 	.name = "mailbox metadata unset",
 	.mail_cmd = cmd_mailbox_metadata_unset_alloc,
-	.usage = "<mailbox> <key>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> <key>",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "mailbox", CMD_PARAM_STR, CMD_PARAM_FLAG_POSITIONAL)
@@ -312,7 +312,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_metadata_get_ver2 = {
 	.name = "mailbox metadata get",
 	.mail_cmd = cmd_mailbox_metadata_get_alloc,
-	.usage = "<mailbox> <key>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> <key>",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "mailbox", CMD_PARAM_STR, CMD_PARAM_FLAG_POSITIONAL)
@@ -323,7 +323,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_metadata_list_ver2 = {
 	.name = "mailbox metadata list",
 	.mail_cmd = cmd_mailbox_metadata_list_alloc,
-	.usage = "<mailbox> [<key prefix>]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> [<key prefix>]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "key-prefix", CMD_PARAM_STR, CMD_PARAM_FLAG_POSITIONAL)

diff --git a/src/doveadm/doveadm-mail-mailbox-status.c b/src/doveadm/doveadm-mail-mailbox-status.c
@@ -250,7 +250,7 @@ static struct doveadm_mail_cmd_context *cmd_mailbox_status_alloc(void)
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_status_ver2 = {
         .name = "mailbox status",
         .mail_cmd = cmd_mailbox_status_alloc,
-        .usage = "<mailbox> [...]",
+        .usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> [...]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('t', "total-sum", CMD_PARAM_BOOL, 0)

diff --git a/src/doveadm/doveadm-mail-mailbox.c b/src/doveadm/doveadm-mail-mailbox.c
@@ -559,7 +559,7 @@ static struct doveadm_mail_cmd_context *cmd_mailbox_unsubscribe_alloc(void)
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_list_ver2 = {
 	.name = "mailbox list",
 	.mail_cmd = cmd_mailbox_list_alloc,
-	.usage = "[-7|-8] [-s] [<mailbox mask> [...]]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-7|-8] [-s] [<mailbox mask> [...]]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('7', "mutf7", CMD_PARAM_BOOL, 0)
@@ -572,7 +572,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_create_ver2 = {
 	.name = "mailbox create",
 	.mail_cmd = cmd_mailbox_create_alloc,
-	.usage = "[-s] [-g <guid>] <mailbox> [...]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-s] [-g <guid>] <mailbox> [...]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('s', "subscriptions", CMD_PARAM_BOOL, 0)
@@ -584,7 +584,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_delete_ver2 = {
 	.name = "mailbox delete",
         .mail_cmd = cmd_mailbox_delete_alloc,
-        .usage = "[-s] <mailbox> [...]",
+        .usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-s] <mailbox> [...]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('s', "subscriptions", CMD_PARAM_BOOL, 0)
@@ -595,7 +595,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_rename_ver2 = {
 	.name = "mailbox rename",
 	.mail_cmd = cmd_mailbox_rename_alloc,
-	.usage = "[-s] <old name> <new name>",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-s] <old name> <new name>",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('s', "subscriptions", CMD_PARAM_BOOL, 0)
@@ -607,7 +607,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_subscribe_ver2 = {
 	.name = "mailbox subscribe",
 	.mail_cmd = cmd_mailbox_subscribe_alloc,
-	.usage = "<mailbox> [...]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> [...]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "mailbox", CMD_PARAM_ARRAY, CMD_PARAM_FLAG_POSITIONAL)
@@ -617,7 +617,7 @@ DOVEADM_CMD_PARAMS_END
 struct doveadm_cmd_ver2 doveadm_cmd_mailbox_unsubscribe_ver2 = {
 	.name = "mailbox unsubscribe",
 	.mail_cmd = cmd_mailbox_unsubscribe_alloc,
-	.usage = "<mailbox> [...]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> [...]",
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON
 DOVEADM_CMD_PARAM('\0', "mailbox", CMD_PARAM_ARRAY, CMD_PARAM_FLAG_POSITIONAL)

diff --git a/src/doveadm/doveadm-mail-save.c b/src/doveadm/doveadm-mail-save.c
@@ -124,7 +124,7 @@ struct doveadm_mail_cmd cmd_save = {
 
 struct doveadm_cmd_ver2 doveadm_cmd_save_ver2 = {
 	.name = "save",
-	.usage = "[-m mailbox]",
+	.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"[-m mailbox]",
 	.mail_cmd = cmd_save_alloc,
 DOVEADM_CMD_PARAMS_START
 DOVEADM_CMD_MAIL_COMMON

diff --git a/src/doveadm/doveadm-mail.c b/src/doveadm/doveadm-mail.c
@@ -766,17 +766,16 @@ void doveadm_mail_usage(string_t *out)
 	array_foreach(&doveadm_mail_cmds, cmd) {
 		if (cmd->usage_args == &doveadm_mail_cmd_hide)
 			continue;
-		str_printfa(out, "%s\t[-u <user>|-A] [-S <socket_path>]",
-			    cmd->name);
+		str_printfa(out, "%s\t"DOVEADM_CMD_MAIL_USAGE_PREFIX, cmd->name);
 		if (cmd->usage_args != NULL)
-			str_printfa(out, " %s", cmd->usage_args);
+			str_append(out, cmd->usage_args);
 		str_append_c(out, '\n');
 	}
 }
 
 void doveadm_mail_help(const struct doveadm_mail_cmd *cmd)
 {
-	fprintf(stderr, "doveadm %s [-u <user>|-A] [-S <socket_path>] %s\n",
+	fprintf(stderr, "doveadm %s "DOVEADM_CMD_MAIL_USAGE_PREFIX" %s\n",
 		cmd->name, cmd->usage_args == NULL ? "" : cmd->usage_args);
 	exit(EX_USAGE);
 }

diff --git a/src/doveadm/doveadm-mail.h b/src/doveadm/doveadm-mail.h
@@ -202,4 +202,7 @@ DOVEADM_CMD_PARAM('S', "socket-path", CMD_PARAM_STR, 0) \
 DOVEADM_CMD_PARAM('u', "user", CMD_PARAM_STR, 0) \
 DOVEADM_CMD_PARAM('F', "user-file", CMD_PARAM_ISTREAM, 0)
 
+#define DOVEADM_CMD_MAIL_USAGE_PREFIX \
+	"[-u <user>|-A] [-S <socket_path>] "
+
 #endif