Skip to contentSkip to conversation

Renaming a remote is 'rename', but removing is 'rm'

PATCH New Tomas Carnecky 4 participants 5 messages Jun 15, 2016 Documentation

lore
Share & tools
lore
#0 lore raw

A fella on IRC was confused by $subject. And it did bother me sometimes as well. If you don't use git remote often, it is confusing that the commands are named inconsistently.

If I know that there is git remote rm then I kindof expect git remote mv to exist. Because I am used to rm/mv and git rm/git mv as the standard unix commands for renaming and removing something. On the other hand, if I know that there is git remote rename, with the verb fully written out, I expect git remote delete/remove to exist (or something similar, with the verb fully written out).

Would there be any desire to make the subcommands more consistent in that regard?

tom

#1 lore raw
Quoted 11 lines · Tomas Carnecky

A fella on IRC was confused by $subject. And it did bother me sometimes as well. If you don't use git remote often, it is confusing that the commands are named inconsistently.

If I know that there is git remote rm then I kindof expect git remote mv to exist. Because I am used to rm/mv and git rm/git mv as the standard unix commands for renaming and removing something. On the other hand, if I know that there is git remote rename, with the verb fully written out, I expect git remote delete/remove to exist (or something similar, with the verb fully written out).

Quoted 2 lines

Would there be any desire to make the subcommands more consistent in that regard?

Looking at the remote command list, "rm" is the only abbreviation. I guess we should add "delete" (or "remove") as an alias for "rm".

Signature · 1 line
Duy
#2 lore raw
Quoted 2 lines · Nguyen Thai Ngoc Duy

Looking at the remote command list, "rm" is the only abbreviation. I guess we should add "delete" (or "remove") as an alias for "rm".

I'd vote for "remove", to make it clear that "rm" is the abbreviation.

Signature · 2 lines
Matthieu Moy
http://www-verimag.imag.fr/~moy/
#3 lore raw
Quoted 6 lines · Matthieu Moy
Quoted 2 lines · Nguyen Thai Ngoc Duy

Looking at the remote command list, "rm" is the only abbreviation. I guess we should add "delete" (or "remove") as an alias for "rm".

I'd vote for "remove", to make it clear that "rm" is the abbreviation.

Sounds sensible. Please make it so.

#4 lore raw

PATCH 1/1 remote: prefer subcommand name 'remove' to 'rm'

All remote subcommands are spelled out words except 'rm'. 'rm', being a popular UNIX command name, may mislead users that there are also 'ls' or 'mv'. Use 'remove' to fit with the rest of subcommands.

'rm' is still supported and used in the test suite. It's just not widely advertised.

---
 Documentation/git-remote.txt           | 3 ++-
 builtin/remote.c                       | 6 +++---
 contrib/completion/git-completion.bash | 4 ++--
 t/t5505-remote.sh                      | 4 ++--
 t/t5540-http-push.sh                   | 2 +-
 5 files changed, 10 insertions(+), 9 deletions(-)
Documentation/git-remote.txt +2 -1
index a308f4c..e8c396b 100644
@@ -12,7 +12,7 @@ SYNOPSIS
 'git remote' [-v | --verbose]
 'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
 'git remote rename' <old> <new>
-'git remote rm' <name>
+'git remote remove' <name>
 'git remote set-head' <name> (-a | -d | <branch>)
 'git remote set-branches' [--add] <name> <branch>...
 'git remote set-url' [--push] <name> <newurl> [<oldurl>]
@@ -85,6 +85,7 @@ In case <old> and <new> are the same, and <old> is a file under
 `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
 the configuration file format.
 
+'remove'::
 'rm'::
 
 Remove the remote named <name>. All remote-tracking branches and
builtin/remote.c +3 -3
index 920262d..357d59d 100644
@@ -11,7 +11,7 @@ static const char * const builtin_remote_usage[] = {
 	"git remote [-v | --verbose]",
 	"git remote add [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>",
 	"git remote rename <old> <new>",
-	"git remote rm <name>",
+	"git remote remove <name>",
 	"git remote set-head <name> (-a | -d | <branch>)",
 	"git remote [-v | --verbose] show [-n] <name>",
 	"git remote prune [-n | --dry-run] <name>",
@@ -34,7 +34,7 @@ static const char * const builtin_remote_rename_usage[] = {
 };
 
 static const char * const builtin_remote_rm_usage[] = {
-	"git remote rm <name>",
+	"git remote remove <name>",
 	NULL
 };
 
@@ -1580,7 +1580,7 @@ int cmd_remote(int argc, const char **argv, const char *prefix)
 		result = add(argc, argv);
 	else if (!strcmp(argv[0], "rename"))
 		result = mv(argc, argv);
-	else if (!strcmp(argv[0], "rm"))
+	else if (!strcmp(argv[0], "rm") || !strcmp(argv[0], "remove"))
 		result = rm(argc, argv);
 	else if (!strcmp(argv[0], "set-head"))
 		result = set_head(argc, argv);
contrib/completion/git-completion.bash +2 -2
index 222b804..0492db9 100644
@@ -2032,7 +2032,7 @@ _git_config ()
 
 _git_remote ()
 {
-	local subcommands="add rename rm set-head set-branches set-url show prune update"
+	local subcommands="add rename remove set-head set-branches set-url show prune update"
 	local subcommand="$(__git_find_on_cmdline "$subcommands")"
 	if [ -z "$subcommand" ]; then
 		__gitcomp "$subcommands"
@@ -2040,7 +2040,7 @@ _git_remote ()
 	fi
 
 	case "$subcommand" in
-	rename|rm|set-url|show|prune)
+	rename|remove|set-url|show|prune)
 		__gitcomp_nl "$(__git_remotes)"
 		;;
 	set-head|set-branches)
t/t5505-remote.sh +2 -2
index e8af615..c03ffdd 100755
@@ -125,7 +125,7 @@ EOF
 	} &&
 	git tag footag &&
 	git config --add remote.oops.fetch "+refs/*:refs/*" &&
-	git remote rm oops 2>actual1 &&
+	git remote remove oops 2>actual1 &&
 	git branch foobranch &&
 	git config --add remote.oops.fetch "+refs/*:refs/*" &&
 	git remote rm oops 2>actual2 &&
@@ -672,7 +672,7 @@ test_expect_success 'migrate a remote from named file in $GIT_DIR/remotes' '
 	git clone one five &&
 	origin_url=$(pwd)/one &&
 	(cd five &&
-	 git remote rm origin &&
+	 git remote remove origin &&
 	 mkdir -p .git/remotes &&
 	 cat ../remotes_origin > .git/remotes/origin &&
 	 git remote rename origin origin &&
t/t5540-http-push.sh +1 -1
index 1eea647..7c14bc4 100755
@@ -117,7 +117,7 @@ test_expect_success 'http-push fetches packed objects' '
 	# By reset, we force git to retrieve the packed object
 	(cd "$ROOT_PATH"/test_repo_clone_packed &&
 	 git reset --hard HEAD^ &&
-	 git remote rm origin &&
+	 git remote remove origin &&
 	 git reflog expire --expire=0 --all &&
 	 git prune &&
 	 git push -f -v $HTTPD_URL/dumb/test_repo_packed.git master)
Signature · 1 line
1.7.12.rc2.18.g61b472e