git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 3/3] remote: run "remote rm" argv through parse_options()

From
Jeff King <peff@peff.net>
Date
Aug 25, 2022, 10:51 UTC
Message-ID
<YwdUPIv097AWRfTI@coredump.intra.peff.net>
In-Reply-To
<YwdSzrF3xaHvLsI+@coredump.intra.peff.net>

The "git remote rm" command's option parsing is fairly primitive: it insists on a single argument, which it treats as the remote name, and displays a usage message otherwise.

This is OK, and maybe even convenient, as you could run:
  git remote rm --foo

to drop a remote named "--foo". But it's also weirdly unlike most of the rest of Git, which would complain that there is no option "--foo". The right way to spell it by our conventions is:

  git remote rm -- --foo
but this doesn't currently work.

So let's bring the command in line with the rest of Git (including its sibling subcommands!) by feeding argv to parse_options(). We already have an empty options array for the usage helper.

Note that we have to adjust the argc index down by one, as parse_options() eats the program name from the start of the array.

Signed-off-by: Jeff King <peff@peff.net>
---
 builtin/remote.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/builtin/remote.c b/builtin/remote.c
index 96f562f00a..9aff864fd6 100644
--- a/builtin/remote.c
+++ b/builtin/remote.c
@@ -862,12 +862,14 @@ static int rm(int argc, const char **argv, const char *prefix)
 	cb_data.skipped = &skipped;
 	cb_data.keep = &known_remotes;
 
-	if (argc != 2)
+	argc = parse_options(argc, argv, prefix, options,
+			     builtin_remote_rm_usage, 0);
+	if (argc != 1)
 		usage_with_options(builtin_remote_rm_usage, options);
 
-	remote = remote_get(argv[1]);
+	remote = remote_get(argv[0]);
 	if (!remote_is_configured(remote, 1)) {
-		error(_("No such remote: '%s'"), argv[1]);
+		error(_("No such remote: '%s'"), argv[0]);
 		exit(2);
 	}
 
-- 
2.37.2.1034.gd926c9c740
Previous: Jeff King
Message 5 of 5 in “unused function parameters newly in next”
  1. 0/3 unused function parameters newly in nextJeff King, Aug 25, 2022
  2. 1/3 pass subcommand "prefix" arguments to parse_options()Jeff King, Aug 25, 2022
  3. Junio C HamanoAug 25, 2022
  4. 2/3 maintenance: add parse-options boilerplate for subcommandsJeff King, Aug 25, 2022
  5. 3/3 remote: run "remote rm" argv through parse_options()Jeff King, Aug 25, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.