From: Eli Schwartz <eschwartz@archlinux.org>
To: git@vger.kernel.org
Cc: "René Scharfe" <l.s.r@web.de>
Subject: [PATCH 3/3] pretty: add abbrev option to %(describe)
Date: Sat, 23 Oct 2021 21:42:56 -0400 [thread overview]
Message-ID: <20211024014256.3569322-4-eschwartz@archlinux.org> (raw)
In-Reply-To: <20211024014256.3569322-1-eschwartz@archlinux.org>
The %(describe) placeholder by default, like `git describe`, uses a
seven-character abbreviated commit hash. This may not be sufficient to
fully describe all git repos, resulting in a placeholder replacement
changing its length because the repository grew in size. This could
cause the output of git-archive to change.
Add the --abbrev option to `git describe` to the placeholder interface
in order to provide tools to the user for fine-tuning project defaults
and ensure reproducible archives.
One alternative would be to just always specify --abbrev=40 but this may
be a bit too biased...
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
---
Documentation/pretty-formats.txt | 4 ++++
pretty.c | 2 +-
t/t4205-log-pretty-formats.sh | 8 ++++++++
3 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 14107ac191..317c1382b5 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -221,6 +221,10 @@ The placeholders are:
the same time.
+
** 'tags[=<BOOL>]': Also consider lightweight tags.
+** 'abbrev=<N>': Instead of using the default number of hexadecimal digits
+ (which will vary according to the number of objects in the repository with a
+ default of 7) of the abbreviated object name, use <n> digits, or as many digits
+ as needed to form a unique object name.
** 'match=<pattern>': Only consider tags matching the given
`glob(7)` pattern, excluding the "refs/tags/" prefix.
** 'exclude=<pattern>': Do not consider tags matching the given
diff --git a/pretty.c b/pretty.c
index 3a41bedf1a..a092457274 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1217,7 +1217,7 @@ int format_set_trailers_options(struct process_trailer_options *opts,
static size_t parse_describe_args(const char *start, struct strvec *args)
{
const char *options[] = { "tags" };
- const char *option_arguments[] = { "match", "exclude" };
+ const char *option_arguments[] = { "match", "exclude", "abbrev" };
const char *arg = start;
for (;;) {
diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh
index d4acf8882f..35eef4c865 100755
--- a/t/t4205-log-pretty-formats.sh
+++ b/t/t4205-log-pretty-formats.sh
@@ -1010,4 +1010,12 @@ test_expect_success '%(describe:tags) vs git describe --tags' '
test_cmp expect actual
'
+test_expect_success '%(describe:abbrev=...) vs git describe --abbrev=...' '
+ test_when_finished "git tag -d tagname" &&
+ git tag -a -m tagged tagname &&
+ git describe --abbrev=15 >expect &&
+ git log -1 --format="%(describe:abbrev=15)" >actual &&
+ test_cmp expect actual
+'
+
test_done
--
2.33.1
next prev parent reply other threads:[~2021-10-24 1:51 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-24 1:42 [PATCH 0/3] Add some more options to the pretty-formats Eli Schwartz
2021-10-24 1:42 ` [PATCH 1/3] pretty.c: rename describe options variable to more descriptive name Eli Schwartz
2021-10-24 4:31 ` Junio C Hamano
2021-10-24 15:37 ` Eli Schwartz
2021-10-24 1:42 ` [PATCH 2/3] pretty: add tag option to %(describe) Eli Schwartz
2021-10-24 4:57 ` Junio C Hamano
2021-10-24 15:38 ` Eli Schwartz
2021-10-24 1:42 ` Eli Schwartz [this message]
2021-10-24 5:15 ` [PATCH 3/3] pretty: add abbrev " Junio C Hamano
2021-10-24 15:43 ` Eli Schwartz
2021-10-26 1:34 ` [PATCH v2 0/3] Add some more options to the pretty-formats Eli Schwartz
2021-10-26 1:34 ` [PATCH v2 1/3] pretty.c: rework describe options parsing for better extensibility Eli Schwartz
2021-10-26 5:18 ` Eric Sunshine
2021-10-26 20:05 ` Eli Schwartz
2021-10-26 1:34 ` [PATCH v2 2/3] pretty: add tag option to %(describe) Eli Schwartz
2021-10-26 5:25 ` Eric Sunshine
2021-10-26 20:06 ` Eli Schwartz
2021-10-26 1:34 ` [PATCH v2 3/3] pretty: add abbrev " Eli Schwartz
2021-10-26 5:36 ` Eric Sunshine
2021-10-26 12:06 ` Đoàn Trần Công Danh
2021-10-26 17:28 ` Eric Sunshine
2021-10-26 19:12 ` Eli Schwartz
2021-10-27 8:05 ` Carlo Arenas
2021-11-03 23:20 ` Johannes Schindelin
2021-11-04 9:29 ` Johannes Schindelin
2021-11-07 12:39 ` Eli Schwartz
2021-10-29 18:45 ` [PATCH v3 0/3] Add some more options to the pretty-formats Eli Schwartz
2021-10-29 18:45 ` [PATCH v3 1/3] pretty.c: rework describe options parsing for better extensibility Eli Schwartz
2021-10-29 20:11 ` Junio C Hamano
2021-10-29 21:06 ` Eli Schwartz
2021-10-29 21:34 ` Junio C Hamano
2021-10-29 18:45 ` [PATCH v3 2/3] pretty: add tag option to %(describe) Eli Schwartz
2021-10-29 20:18 ` Junio C Hamano
2021-10-29 21:14 ` Eli Schwartz
2021-10-29 21:46 ` Junio C Hamano
2021-10-29 21:28 ` Junio C Hamano
2021-10-29 21:44 ` Eli Schwartz
2021-10-29 18:45 ` [PATCH v3 3/3] pretty: add abbrev " Eli Schwartz
2021-10-29 18:51 ` Eric Sunshine
2021-10-29 19:04 ` Eli Schwartz
2021-10-31 17:15 ` [PATCH v4 0/3] Add some more options to the pretty-formats Eli Schwartz
2021-10-31 17:15 ` [PATCH v4 1/3] pretty.c: rework describe options parsing for better extensibility Eli Schwartz
2021-10-31 17:15 ` [PATCH v4 2/3] pretty: add tag option to %(describe) Eli Schwartz
2021-10-31 18:07 ` Junio C Hamano
2021-10-31 18:58 ` Eli Schwartz
2021-10-31 17:15 ` [PATCH v4 3/3] pretty: add abbrev " Eli Schwartz
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211024014256.3569322-4-eschwartz@archlinux.org \
--to=eschwartz@archlinux.org \
--cc=git@vger.kernel.org \
--cc=l.s.r@web.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).