diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-03-27 20:59:27 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-03-27 20:59:28 +0300 |
| commit | 844768a29864cac01d55463a8858457f4908d91e (patch) | |
| tree | 162616606279e87603e772c02f1dbcf877bf999f /Documentation | |
| parent | 4e87565d2a3e315b7afc39e9e1fe98c5607a1b11 (diff) | |
| parent | b0176ce6b5d954a747dc4d0c5a8593ed576714c4 (diff) | |
Merge branch 'sb/describe-broken'
"git describe --dirty" dies when it cannot be determined if the
state in the working tree matches that of HEAD (e.g. broken
repository or broken submodule). The command learned a new option
"git describe --broken" to give "$name-broken" (where $name is the
description of HEAD) in such a case.
* sb/describe-broken:
builtin/describe: introduce --broken flag
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-describe.txt | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 8755f3af7b..26f19d3b07 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/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 |