Rename "shuffle" command to "reshuffle"

This should reduce confusion. The old command is still supported, but hidden from completion.
VladislavGrudinin · May 30, 2021 · 2b4e06f · 2b4e06f
1 parent 8355bd6
commit 2b4e06f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/Doc/cmus.txt b/Doc/cmus.txt
@@ -579,6 +579,9 @@ rand
 refresh (*^L*)
 	Redraws the terminal window.
 
+reshuffle
+	Reshuffles the shuffle lists for both library and playlist views.
+
 run <command>
 	Runs a command for the marked tracks OR the selected one if none marked.
 
@@ -658,9 +661,6 @@ shell <command>
 showbind <context> <key>
 	Shows a key binding.
 
-shuffle
-	Reshuffles the shuffle lists for both library and playlist views.
-
 source <filename>
 	Reads and executes commands from <filename>.
 

diff --git a/command_mode.c b/command_mode.c
@@ -2634,6 +2634,7 @@ struct command commands[] = {
 	{ "rand",                  cmd_rand,             0, 0,  NULL,                 0, 0          },
 	{ "quit",                  cmd_quit,             0, 1,  NULL,                 0, 0          },
 	{ "refresh",               cmd_refresh,          0, 0,  NULL,                 0, 0          },
+	{ "reshuffle",             cmd_reshuffle,        0, 0,  NULL,                 0, 0          },
 	{ "run",                   cmd_run,              1, -1, expand_program_paths, 0, CMD_UNSAFE },
 	{ "save",                  cmd_save,             0, 1,  expand_load_save,     0, CMD_UNSAFE },
 	{ "search-b-start",        cmd_search_b_start,   0, 0,  NULL,                 0, 0          },
@@ -2644,7 +2645,7 @@ struct command commands[] = {
 	{ "set",                   cmd_set,              1, 1,  expand_options,       0, 0          },
 	{ "shell",                 cmd_shell,            1, -1, expand_program_paths, 0, CMD_UNSAFE },
 	{ "showbind",              cmd_showbind,         1, 1,  expand_unbind_args,   0, 0          },
-	{ "shuffle",               cmd_reshuffle,        0, 0,  NULL,                 0, 0          },
+	{ "shuffle",               cmd_reshuffle,        0, 0,  NULL,                 0, CMD_HIDDEN },
 	{ "source",                cmd_source,           1, 1,  expand_files,         0, CMD_UNSAFE },
 	{ "toggle",                cmd_toggle,           1, 1,  expand_toptions,      0, 0          },
 	{ "tqueue",                cmd_tqueue,           0, 1,  NULL,                 0, 0          },
@@ -2696,7 +2697,7 @@ static void expand_commands(const char *str)
 	len = strlen(str);
 	pos = 0;
 	for (i = 0; commands[i].name; i++) {
-		if (strncmp(str, commands[i].name, len) == 0)
+		if (strncmp(str, commands[i].name, len) == 0 && !(commands[i].flags & CMD_HIDDEN))
 			tails[pos++] = xstrdup(commands[i].name + len);
 	}
 	if (pos > 0) {

diff --git a/command_mode.h b/command_mode.h
@@ -32,6 +32,8 @@ enum {
 	CMD_UNSAFE	= 1 << 0,
 	/* execute command after every typed/deleted character */
 	CMD_LIVE	= 1 << 1,
+	/* hide command from completion, useful for deprecated commands */
+	CMD_HIDDEN	= 1 << 2,
 };
 
 struct command {