[PATCH 8/8] describe docs: note that <commit> is optional
Signed-off-by: Mark Lodato <lodatom@gmail.com>
---
Documentation/git-describe.txt | 3 ++-
Documentation/gitcli.txt | 2 +-
builtin/describe.c | 2 +-
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index ad173ed..8006d59 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>...
+'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit>...]
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
DESCRIPTION
@@ -28,6 +28,7 @@ OPTIONS
-------
<commit>...::
Commit object names to describe.
+ If not given, defaults to HEAD.
--dirty[=<mark>]::
Describe the working tree.
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index b56e7c3..e57f88c 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -81,7 +81,7 @@ couple of magic command line options:
+
---------------------------------------------
$ git describe -h
-usage: git describe [options] <commit>...
+usage: git describe [options] [<commit>...]
--contains find the tag that comes after the commit
--debug debug search strategy on stderr
diff --git a/builtin/describe.c b/builtin/describe.c
index 4b5a217..82da278 100644
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -12,7 +12,7 @@
#define MAX_TAGS (FLAG_BITS - 1)
static const char * const describe_usage[] = {
- "git describe [options] <commit>...",
+ "git describe [options] [<commit>...]",
"git describe [options] --dirty",
NULL
};
--
1.7.3.2
Mark Lodato <lodatom@gmail.com>