Re: [PATCH 1/2] pretty: add %(describe)
- From
René Scharfe. <l.s.r@web.de>
- Date
- Feb 28, 2021, 11:22 UTC
- Message-ID
- <c65039f2-46d3-bbb4-1aa1-e0ce89f69b64@web.de>
- In-Reply-To
- <87mtw3a5af.fsf@evledraar.gmail.com>
Am 17.02.21 um 01:47 schrieb Ævar Arnfjörð Bjarmason:
Show 10 quoted lines
> Usually something shelling out has going for it is that even if it's > slow it's at least known to be bug-free, after all we use the command > like that already. > > I just wanted to point out this edge case, for "git describe <commits>" > we do the ref list once at the beginning so our N list will be > consistent within itself. > > Whereas one might expect "git log" to also format such a list, but due > to the internal implementation the semantics are different.
It shouldn't matter for the intended use case (git archive containing a spec file with a single "$Format:%(describe)$") and I cannot imagine how consistency in the face of tag changes would be useful (what application would be OK with consistently outdated output, but break with partly outdated descriptions). But it makes sense to mention it in the docs.
-- >8 -- Subject: [PATCH] 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> --- Documentation/pretty-formats.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
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. -- 2.30.1