Skip to content

Commit 273c990

Browse files
rscharfegitster
authored andcommitted
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 <[email protected]> Signed-off-by: René Scharfe <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 09fe8ca commit 273c990

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Documentation/pretty-formats.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,9 @@ The placeholders are:
212212
linkgit:git-describe[1]; empty string for
213213
undescribable commits. The `describe` string
214214
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.
216218
+
217219
** 'match=<pattern>': Only consider tags matching the given
218220
`glob(7)` pattern, excluding the "refs/tags/" prefix.

0 commit comments

Comments
 (0)