summaryrefslogtreecommitdiffstats
path: root/git-describe.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-03-27 11:23:59 -0700
committerJunio C Hamano <gitster@pobox.com>2017-03-27 11:23:59 -0700
commit7ab74c417c5b91c9b0cabd4b4ba94884c0aff570 (patch)
tree6b674fc3b14787043a359b5bec8787ff6830c36b /git-describe.txt
parent7f4fdacfb06ac5b89d5a3c9826ec749a36e474c6 (diff)
downloadgit-htmldocs-7ab74c417c5b91c9b0cabd4b4ba94884c0aff570.tar.gz
Autogenerated HTML docs for v2.12.2-430-ge0ef7
Diffstat (limited to 'git-describe.txt')
-rw-r--r--git-describe.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/git-describe.txt b/git-describe.txt
index 8755f3af7..26f19d3b0 100644
--- a/git-describe.txt
+++ b/git-describe.txt
@@ -30,9 +30,14 @@ OPTIONS
Commit-ish object names to describe. Defaults to HEAD if omitted.
--dirty[=<mark>]::
- Describe the working tree.
- It means describe HEAD and appends <mark> (`-dirty` by
- default) if the working tree is dirty.
+--broken[=<mark>]::
+ Describe the state of the working tree. When the working
+ tree matches HEAD, the output is the same as "git describe
+ HEAD". If the working tree has local modification "-dirty"
+ is appended to it. If a repository is corrupt and Git
+ cannot determine if there is local modification, Git will
+ error out, unless `--broken' is given, which appends
+ the suffix "-broken" instead.
--all::
Instead of using only the annotated tags, use any ref