Skip to content

Commit b6839fd

Browse files
chriscoolgitster
authored andcommitted
ref-filter: add support for %(contents:size)
It's useful and efficient to be able to get the size of the contents directly without having to pipe through `wc -c`. Also the result of the following: `git for-each-ref --format='%(contents)' refs/heads/my-branch | wc -c` is off by one as `git for-each-ref` appends a newline character after the contents, which can be seen by comparing its output with the output from `git cat-file`. As with %(contents), %(contents:size) is silently ignored, if a ref points to something other than a commit or a tag: ``` $ git update-ref refs/mytrees/first HEAD^{tree} $ git for-each-ref --format='%(contents)' refs/mytrees/first $ git for-each-ref --format='%(contents:size)' refs/mytrees/first ``` Signed-off-by: Christian Couder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6e2ef8e commit b6839fd

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

Documentation/git-for-each-ref.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,9 @@ and `date` to extract the named component.
235235
The message in a commit or a tag object is `contents`, from which
236236
`contents:<part>` can be used to extract various parts out of:
237237

238+
contents:size::
239+
The size in bytes of the commit or tag message.
240+
238241
contents:subject::
239242
The first paragraph of the message, which typically is a
240243
single line, is taken as the "subject" of the commit or the

ref-filter.c

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ static struct used_atom {
127127
unsigned int nobracket : 1, push : 1, push_remote : 1;
128128
} remote_ref;
129129
struct {
130-
enum { C_BARE, C_BODY, C_BODY_DEP, C_LINES, C_SIG, C_SUB, C_TRAILERS } option;
130+
enum { C_BARE, C_BODY, C_BODY_DEP, C_LENGTH,
131+
C_LINES, C_SIG, C_SUB, C_TRAILERS } option;
131132
struct process_trailer_options trailer_opts;
132133
unsigned int nlines;
133134
} contents;
@@ -338,6 +339,8 @@ static int contents_atom_parser(const struct ref_format *format, struct used_ato
338339
atom->u.contents.option = C_BARE;
339340
else if (!strcmp(arg, "body"))
340341
atom->u.contents.option = C_BODY;
342+
else if (!strcmp(arg, "size"))
343+
atom->u.contents.option = C_LENGTH;
341344
else if (!strcmp(arg, "signature"))
342345
atom->u.contents.option = C_SIG;
343346
else if (!strcmp(arg, "subject"))
@@ -1253,6 +1256,8 @@ static void grab_sub_body_contents(struct atom_value *val, int deref, void *buf)
12531256
v->s = copy_subject(subpos, sublen);
12541257
else if (atom->u.contents.option == C_BODY_DEP)
12551258
v->s = xmemdupz(bodypos, bodylen);
1259+
else if (atom->u.contents.option == C_LENGTH)
1260+
v->s = xstrfmt("%"PRIuMAX, (uintmax_t)strlen(subpos));
12561261
else if (atom->u.contents.option == C_BODY)
12571262
v->s = xmemdupz(bodypos, nonsiglen);
12581263
else if (atom->u.contents.option == C_SIG)

t/t6300-for-each-ref.sh

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,25 @@ test_atom() {
5252
sanitize_pgp <actual >actual.clean &&
5353
test_cmp expected actual.clean
5454
"
55+
# Automatically test "contents:size" atom after testing "contents"
56+
if test "$2" = "contents"
57+
then
58+
case $(git cat-file -t "$ref") in
59+
tag)
60+
# We cannot use $3 as it expects sanitize_pgp to run
61+
expect=$(git cat-file tag $ref | tail -n +6 | wc -c) ;;
62+
tree | blob)
63+
expect='' ;;
64+
commit)
65+
expect=$(printf '%s' "$3" | wc -c) ;;
66+
esac
67+
# Leave $expect unquoted to lose possible leading whitespaces
68+
echo $expect >expected
69+
test_expect_${4:-sucess} $PREREQ "basic atom: $1 contents:size" '
70+
git for-each-ref --format="%(contents:size)" "$ref" >actual &&
71+
test_cmp expect actual
72+
'
73+
fi
5574
}
5675

5776
hexlen=$(test_oid hexsz)

0 commit comments

Comments
 (0)