X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-describe.txt;h=78b9808aa3a2f5fe2435ea188ac4e73508c2720a;hb=f012d27ff3e37d0412bba34ca53a2d444fd3c563;hp=2f979167819f0e4500b998b41092e18ef053cead;hpb=f2c0ca4fae299c2515c1554dbeec2080af5c6792;p=git.git diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 2f9791678..78b9808aa 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -8,7 +8,9 @@ git-describe - Show the most recent tag that is reachable from a commit SYNOPSIS -------- +[verse] 'git describe' [--all] [--tags] [--contains] [--abbrev=] ... +'git describe' [--all] [--tags] [--contains] [--abbrev=] --dirty[=] DESCRIPTION ----------- @@ -27,6 +29,11 @@ OPTIONS ...:: Committish object names to describe. +--dirty[=]:: + Describe the working tree. + It means describe HEAD and appends (`-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