From: Eli Schwartz <eschwartz@archlinux.org>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
Eric Sunshine <sunshine@sunshineco.com>
Subject: [PATCH v4 3/3] pretty: add abbrev option to %(describe)
Date: Sun, 31 Oct 2021 13:15:10 -0400 [thread overview]
Message-ID: <20211031171510.1646396-4-eschwartz@archlinux.org> (raw)
In-Reply-To: <20211031171510.1646396-1-eschwartz@archlinux.org>
The %(describe) placeholder by default, like `git describe`, uses a
seven-character abbreviated commit object name. This may not be
sufficient to fully describe all commits in a given repository,
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 | 15 +++++++++++++++
t/t4205-log-pretty-formats.sh | 8 ++++++++
3 files changed, 27 insertions(+)
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 1ee47bd4a3..9e943fb74b 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -222,6 +222,10 @@ The placeholders are:
+
** 'tags[=<bool>]': Instead of only considering annotated tags,
consider lightweight tags as well.
+** 'abbrev=<number>': 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 <number> 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 403d89725a..fa9bfea273 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1216,10 +1216,12 @@ static size_t parse_describe_args(const char *start, struct strvec *args)
char *name;
enum {
DESCRIBE_ARG_BOOL,
+ DESCRIBE_ARG_INTEGER,
DESCRIBE_ARG_STRING,
} type;
} option[] = {
{ "tags", DESCRIBE_ARG_BOOL},
+ { "abbrev", DESCRIBE_ARG_INTEGER },
{ "exclude", DESCRIBE_ARG_STRING },
{ "match", DESCRIBE_ARG_STRING },
};
@@ -1243,6 +1245,19 @@ static size_t parse_describe_args(const char *start, struct strvec *args)
found = 1;
}
break;
+ case DESCRIBE_ARG_INTEGER:
+ if (match_placeholder_arg_value(arg, option[i].name, &arg,
+ &argval, &arglen)) {
+ char *endptr;
+ if (!arglen)
+ return 0;
+ strtol(argval, &endptr, 10);
+ if (endptr - argval != arglen)
+ return 0;
+ strvec_pushf(args, "--%s=%.*s", option[i].name, (int)arglen, argval);
+ found = 1;
+ }
+ break;
case DESCRIBE_ARG_STRING:
if (match_placeholder_arg_value(arg, option[i].name, &arg,
&argval, &arglen)) {
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
prev parent reply other threads:[~2021-10-31 17:15 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 ` [PATCH 3/3] pretty: add abbrev " Eli Schwartz
2021-10-24 5:15 ` 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 ` Eli Schwartz [this message]
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=20211031171510.1646396-4-eschwartz@archlinux.org \
--to=eschwartz@archlinux.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sunshine@sunshineco.com \
/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).