aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-describe.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2009-11-10 12:30:43 -0800
committerJunio C Hamano <gitster@pobox.com>2009-11-10 12:30:43 -0800
commit48cbf915a4738097f291de06e23d293f79ff3f9e (patch)
treeca9b4a0f606900e8536e704508fd318d7514d2f0 /Documentation/git-describe.txt
parent25dfd1b925f51a88b00cf0c84c690d448395c30f (diff)
parent9f67d2e8279e1885ef2b4681c19cef8534259783 (diff)
downloadgit-48cbf915a4738097f291de06e23d293f79ff3f9e.tar.gz
Merge branch 'jp/dirty-describe'
* jp/dirty-describe: Teach "git describe" --dirty option
Diffstat (limited to 'Documentation/git-describe.txt')
-rw-r--r--Documentation/git-describe.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 2f97916781..d7329eb4c0 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -9,6 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
SYNOPSIS
--------
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>...
+'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
DESCRIPTION
-----------
@@ -27,6 +28,11 @@ OPTIONS
<committish>...::
Committish object names to describe.
+--dirty[=<mark>]::
+ Describe the working tree.
+ It means describe HEAD and appends <mark> (`-dirty` by
+ default) if the working tree is dirty.
+
--all::
Instead of using only the annotated tags, use any ref
found in `.git/refs/`. This option enables matching