mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pretty: document multiple %(describe) being inconsistent

Browse Source 
Each %(describe) placeholder is expanded using a separate git describe
call.  Their outputs depend on the tags present at the time, so there's
no consistency guarantee.  Document that fact.

Reported-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
René Scharfe
2021-02-28 12:22:34 +01:00
committed by Junio C Hamano
parent 09fe8ca92e
commit 273c9901c2
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/pretty-formats.txt
View File

@ -212,7 +212,9 @@ The placeholders are:
linkgit:git-describe[1]; empty string for linkgit:git-describe[1]; empty string for
undescribable commits. The `describe` string undescribable commits. The `describe` string
may be followed by a colon and zero or more may be followed by a colon and zero or more
comma-separated options. comma-separated options. Descriptions can be
inconsistent when tags are added or removed at
the same time.
+ +
** 'match=<pattern>': Only consider tags matching the given ** 'match=<pattern>': Only consider tags matching the given
`glob(7)` pattern, excluding the "refs/tags/" prefix. `glob(7)` pattern, excluding the "refs/tags/" prefix.