summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorSZEDER Gábor <szeder@ira.uka.de>2015-08-24 16:15:18 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-08-25 16:35:13 (GMT)
commit2bd07065c3ed8a1bd2dc6f5d8e914dfec31e3dca (patch)
treeb6a65172ecba1df898183b9aa6d8fefff918eb61 /Documentation
parent282616c72d1d08a77ca4fe1186cb708c38408d87 (diff)
downloadgit-2bd07065c3ed8a1bd2dc6f5d8e914dfec31e3dca.zip
git-2bd07065c3ed8a1bd2dc6f5d8e914dfec31e3dca.tar.gz
git-2bd07065c3ed8a1bd2dc6f5d8e914dfec31e3dca.tar.bz2
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 <szeder@ira.uka.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-describe.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index d20ca40..363e501 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -9,7 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
SYNOPSIS
--------
[verse]
-'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit-ish>...
+'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
DESCRIPTION
@@ -27,7 +27,7 @@ see the -a and -s options to linkgit:git-tag[1].
OPTIONS
-------
<commit-ish>...::
- Commit-ish object names to describe.
+ Commit-ish object names to describe. Defaults to HEAD if omitted.
--dirty[=<mark>]::
Describe the working tree.