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>
René Scharfe committed
Feb 28, 2021 at 12:22 UTC
273c9901c2ebfb2dae0c52de912bf3f57be19aac
1 file changed
+3
-1
Documentation/pretty-formats.txt
+3
-1
@@ -212,7 +212,9 @@ The placeholders are:
212
linkgit:git-describe[1]; empty string for
213
undescribable commits. The `describe` string
214
may be followed by a colon and zero or more
215
- comma-separated options.
215
+ comma-separated options. Descriptions can be
216
+ inconsistent when tags are added or removed at
217
+ the same time.
218
+
219
** 'match=<pattern>': Only consider tags matching the given
220
`glob(7)` pattern, excluding the "refs/tags/" prefix.