Skip to content

Commit 2bd0706

Browse files
szedergitster
authored andcommitted
describe --contains: default to HEAD when no commit-ish is given
'git describe --contains' doesn't default to HEAD when no commit is given, and it doesn't produce any output, not even an error: ~/src/git ((v2.5.0))$ ./git describe --contains ~/src/git ((v2.5.0))$ ./git describe --contains HEAD v2.5.0^0 Unlike other 'git describe' options, the '--contains' code path is implemented by calling 'name-rev' with a bunch of options plus all the commit-ishes that were passed to 'git describe'. If no commit-ish was present, then 'name-rev' got invoked with none, which then leads to the behavior illustrated above. Porcelain commands usually default to HEAD when no commit-ish is given, and 'git describe' already does so in all other cases, so it should do so with '--contains' as well. Pass HEAD to 'name-rev' when no commit-ish is given on the command line to make '--contains' behave consistently with other 'git describe' options. While at it, use argv_array_pushv() instead of the loop to pass commit-ishes to 'git name-rev'. 'git describe's short help already indicates that the commit-ish is optional, but the synopsis in the man page doesn't, so update it accordingly as well. Signed-off-by: SZEDER Gábor <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 282616c commit 2bd0706

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

Documentation/git-describe.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>...
12+
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]
1313
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
1414

1515
DESCRIPTION
@@ -27,7 +27,7 @@ see the -a and -s options to linkgit:git-tag[1].
2727
OPTIONS
2828
-------
2929
<commit-ish>...::
30-
Commit-ish object names to describe.
30+
Commit-ish object names to describe. Defaults to HEAD if omitted.
3131

3232
--dirty[=<mark>]::
3333
Describe the working tree.

builtin/describe.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -451,10 +451,10 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
451451
if (pattern)
452452
argv_array_pushf(&args, "--refs=refs/tags/%s", pattern);
453453
}
454-
while (*argv) {
455-
argv_array_push(&args, *argv);
456-
argv++;
457-
}
454+
if (argc)
455+
argv_array_pushv(&args, argv);
456+
else
457+
argv_array_push(&args, "HEAD");
458458
return cmd_name_rev(args.argc, args.argv, prefix);
459459
}
460460

t/t6120-describe.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ check_describe A-3-* --long HEAD^^2
113113
check_describe c-7-* --tags
114114
check_describe e-3-* --first-parent --tags
115115

116+
test_expect_success 'describe --contains defaults to HEAD without commit-ish' '
117+
echo "A^0" >expect &&
118+
git checkout A &&
119+
test_when_finished "git checkout -" &&
120+
git describe --contains >actual &&
121+
test_cmp expect actual
122+
'
123+
116124
: >err.expect
117125
check_describe A --all A^0
118126
test_expect_success 'no warning was displayed for A' '

0 commit comments

Comments
 (0)