diff options
| author |  René Scharfe <l.s.r@web.de> | 2021-02-28 12:22:34 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-03-01 09:50:27 -0800 |
| commit | 273c9901c2ebfb2dae0c52de912bf3f57be19aac (patch) | |
| tree | f2ff575c1cf41f8ea0a83bda0c355e65a1a7c2ea | |
| parent | t4205: assert %(describe) test coverage (diff) | |
| download | tgif-273c9901c2ebfb2dae0c52de912bf3f57be19aac.tar.xz | |
pretty: document multiple %(describe) being inconsistent
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>
| -rw-r--r-- | Documentation/pretty-formats.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index 231010e6ef..45133066e4 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -212,7 +212,9 @@ The placeholders are: linkgit:git-describe[1]; empty string for undescribable commits. The `describe` string 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 `glob(7)` pattern, excluding the "refs/tags/" prefix. |