[RFC,1/1] builtin/remote: quote remote name on error to display empty name

Commit Message

Shulhan Sept. 12, 2018, 2:45 p.m. UTC

Rationale: consistent error format

When adding new remote name with empty string, git will print the
following error message,

  fatal: '' is not a valid remote name\n

But when removing remote name with empty string as input, git did not
print the empty string with quote,

  fatal: No such remote: \n
---
 builtin/remote.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Junio C Hamano Sept. 12, 2018, 9:28 p.m. UTC | #1

Shulhan <[e-mail]> writes:

> Rationale: consistent error format

You can and should drop this line.

> When adding new remote name with empty string, git will print the
> following error message,
>
>   fatal: '' is not a valid remote name\n
>
> But when removing remote name with empty string as input, git did not
> print the empty string with quote,

"git shows the empty string without quote" would be easier to
understand which part of the behaviour you are disturbed by.

>   fatal: No such remote: \n

After stating the above observation, you can say something like

	To make these error messages consistent, quote the name of
	the remote that we tried and failed to find.

at the end.

> ---

Needs sign-off.  See Documentation/SubmittingPatches.

>  builtin/remote.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/builtin/remote.c b/builtin/remote.c
> index 40c6f8a1b..f7edf7f2c 100644
> --- a/builtin/remote.c
> +++ b/builtin/remote.c
> @@ -626,7 +626,7 @@ static int mv(int argc, const char **argv)
>  
>  	oldremote = remote_get(rename.old_name);
>  	if (!remote_is_configured(oldremote, 1))
> -		die(_("No such remote: %s"), rename.old_name);
> +		die(_("No such remote: '%s'"), rename.old_name);
>  
>  	if (!strcmp(rename.old_name, rename.new_name) && oldremote->origin != REMOTE_CONFIG)
>  		return migrate_file(oldremote);
> @@ -762,7 +762,7 @@ static int rm(int argc, const char **argv)
>  
>  	remote = remote_get(argv[1]);
>  	if (!remote_is_configured(remote, 1))
> -		die(_("No such remote: %s"), argv[1]);
> +		die(_("No such remote: '%s'"), argv[1]);
>  
>  	known_remotes.to_delete = remote;
>  	for_each_remote(add_known_remote, &known_remotes);
> @@ -861,7 +861,7 @@ static int get_remote_ref_states(const char *name,
>  
>  	states->remote = remote_get(name);
>  	if (!states->remote)
> -		return error(_("No such remote: %s"), name);
> +		return error(_("No such remote: '%s'"), name);
>  
>  	read_branches();

Patch

diff --git a/builtin/remote.c b/builtin/remote.c
index 40c6f8a1b..f7edf7f2c 100644
--- a/builtin/remote.c
+++ b/builtin/remote.c
@@ -626,7 +626,7 @@  static int mv(int argc, const char **argv)
 
 	oldremote = remote_get(rename.old_name);
 	if (!remote_is_configured(oldremote, 1))
-		die(_("No such remote: %s"), rename.old_name);
+		die(_("No such remote: '%s'"), rename.old_name);
 
 	if (!strcmp(rename.old_name, rename.new_name) && oldremote->origin != REMOTE_CONFIG)
 		return migrate_file(oldremote);
@@ -762,7 +762,7 @@  static int rm(int argc, const char **argv)
 
 	remote = remote_get(argv[1]);
 	if (!remote_is_configured(remote, 1))
-		die(_("No such remote: %s"), argv[1]);
+		die(_("No such remote: '%s'"), argv[1]);
 
 	known_remotes.to_delete = remote;
 	for_each_remote(add_known_remote, &known_remotes);
@@ -861,7 +861,7 @@  static int get_remote_ref_states(const char *name,
 
 	states->remote = remote_get(name);
 	if (!states->remote)
-		return error(_("No such remote: %s"), name);
+		return error(_("No such remote: '%s'"), name);
 
 	read_branches();