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

[PATCH 3/4] rev-parse parseopt: interpret any whitespace as start of help text

From
Brandon Casey <drafnel@gmail.com>
Date
Sep 17, 2017, 22:28 UTC
Message-ID
<1505687297-31183-3-git-send-email-drafnel@gmail.com>
In-Reply-To
<1505687297-31183-1-git-send-email-drafnel@gmail.com>

Currently, rev-parse only interprets a space ' ' character as the delimiter between the option spec and the help text. So if a tab character is placed between the option spec and the help text, it will be interpreted as part of the long option name or as part of the arg hint. If it is interpreted as part of the long option name, then rev-parse will produce what will be interpreted as multiple arguments on the command line.

For example, the following option spec (note: there is a <tab> between "frotz" and "enable"):

    frotz	enable frotzing
will produce the following set expression when --frotz is used:
    set -- --frotz --
instead of this:
    set -- --frotz  enable --
Mark t1502.2 as fixed.
Signed-off-by: Brandon Casey <drafnel@gmail.com>
---
 builtin/rev-parse.c           | 12 ++++++++++--
 t/t1502-rev-parse-parseopt.sh |  2 +-
 2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/builtin/rev-parse.c b/builtin/rev-parse.c
index b19f677..351b1a3 100644
--- a/builtin/rev-parse.c
+++ b/builtin/rev-parse.c
@@ -387,6 +387,14 @@ static const char *skipspaces(const char *s)
 	return s;
 }
 
+static char *findspace(const char *s)
+{
+	for (; *s; s++)
+		if (isspace(*s))
+			return (char*)s;
+	return NULL;
+}
+
 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
 {
 	static int keep_dashdash = 0, stop_at_non_option = 0;
@@ -444,8 +452,8 @@ static int cmd_parseopt(int argc, const char **argv, const char *prefix)
 		memset(opts + onb, 0, sizeof(opts[onb]));
 
 		o = &opts[onb++];
-		help = strchr(sb.buf, ' ');
-		if (!help || *sb.buf == ' ') {
+		help = findspace(sb.buf);
+		if (!help || sb.buf == help) {
 			o->type = OPTION_GROUP;
 			o->help = xstrdup(skipspaces(sb.buf));
 			continue;
diff --git a/t/t1502-rev-parse-parseopt.sh b/t/t1502-rev-parse-parseopt.sh
index 3d895e0..6e1b45f 100755
--- a/t/t1502-rev-parse-parseopt.sh
+++ b/t/t1502-rev-parse-parseopt.sh
@@ -38,7 +38,7 @@ test_expect_success 'setup optionspec' '
 EOF
 '
 
-test_expect_failure 'test --parseopt help output' '
+test_expect_success 'test --parseopt help output' '
 	sed -e "s/^|//" >expect <<\END_EXPECT &&
 |cat <<\EOF
 |usage: some-command [options] <args>...
-- 
2.2.0.rc3
Previous: Brandon CaseyNext: Brandon Casey
Message 3 of 4 in “t1502: demonstrate rev-parse --parseopt option mis-parsing”
  1. 1/4 t1502: demonstrate rev-parse --parseopt option mis-parsingBrandon Casey, Sep 17, 2017
  2. 2/4 rev-parse parseopt: do not search help text for flag charsBrandon Casey, Sep 17, 2017
  3. 3/4 rev-parse parseopt: interpret any whitespace as start of help textBrandon Casey, Sep 17, 2017
  4. 4/4 git-rebase: don't ignore unexpected command line argumentsBrandon Casey, Sep 17, 2017

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.