Skip to content

Commit

Permalink
ls-files: add %(objectsize) atom to format option
Browse files Browse the repository at this point in the history
Sometimes users may want to align the feature of
`git ls-files --format` with that of `git ls-tree --format`,
but the %(objectsize) and %(objectsize:padded) are missing
in the format option of git ls-files compared to git ls-tree.

Therefore, the %(objecttsize) atom is added to the format
option of git ls-files, which can be used to obtain the
object size of the file which is recorded in the index.
("-" if the object is a `commit` or `tree`) It also
supports a padded format of size with %(objectsize:padded).

Signed-off-by: ZheNing Hu <adlternative@gmail.com>
  • Loading branch information
adlternative committed May 13, 2023
1 parent 3f88844 commit 95f1d71
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Documentation/git-ls-files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,10 @@ objecttype::
The object type of the file which is recorded in the index.
objectname::
The name of the file which is recorded in the index.
objectsize[:padded]::
The object size of the file which is recorded in the index
("-" if the object is a `commit` or `tree`).
It also supports a padded format of size with "%(objectsize:padded)".
stage::
The stage of the file which is recorded in the index.
eolinfo:index::
Expand Down
25 changes: 25 additions & 0 deletions builtin/ls-files.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
#include "setup.h"
#include "submodule.h"
#include "submodule-config.h"
#include "object-store.h"
#include "hex.h"


static int abbrev;
static int show_deleted;
Expand Down Expand Up @@ -241,6 +244,24 @@ static void show_submodule(struct repository *superproject,
repo_clear(&subrepo);
}

static void expand_objectsize(struct strbuf *line, const struct object_id *oid,
const enum object_type type, unsigned int padded)
{
if (type == OBJ_BLOB) {
unsigned long size;
if (oid_object_info(the_repository, oid, &size) < 0)
die(_("could not get object info about '%s'"),
oid_to_hex(oid));
if (padded)
strbuf_addf(line, "%7"PRIuMAX, (uintmax_t)size);
else
strbuf_addf(line, "%"PRIuMAX, (uintmax_t)size);
} else if (padded) {
strbuf_addf(line, "%7s", "-");
} else {
strbuf_addstr(line, "-");
}
}
struct show_index_data {
const char *pathname;
struct index_state *istate;
Expand Down Expand Up @@ -274,6 +295,10 @@ static size_t expand_show_index(struct strbuf *sb, const char *start,
strbuf_add_unique_abbrev(sb, &data->ce->oid, abbrev);
else if (skip_prefix(start, "(objecttype)", &p))
strbuf_addstr(sb, type_name(object_type(data->ce->ce_mode)));
else if (skip_prefix(start, "(objectsize:padded)", &p))
expand_objectsize(sb, &data->ce->oid, object_type(data->ce->ce_mode), 1);
else if (skip_prefix(start, "(objectsize)", &p))
expand_objectsize(sb, &data->ce->oid, object_type(data->ce->ce_mode), 0);
else if (skip_prefix(start, "(stage)", &p))
strbuf_addf(sb, "%d", ce_stage(data->ce));
else if (skip_prefix(start, "(eolinfo:index)", &p))
Expand Down
28 changes: 28 additions & 0 deletions t/t3013-ls-files-format.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,34 @@ test_expect_success 'git ls-files --format objecttype' '
test_cmp expect actual
'

test_expect_success 'git ls-files --format objectsize' '
cat>expect <<-\EOF &&
26
29
27
26
-
26
EOF
git ls-files --format="%(objectsize)" >actual &&
test_cmp expect actual
'

test_expect_success 'git ls-files --format objectsize:padded' '
cat>expect <<-\EOF &&
26
29
27
26
-
26
EOF
git ls-files --format="%(objectsize:padded)" >actual &&
test_cmp expect actual
'

test_expect_success 'git ls-files --format v.s. --eol' '
git ls-files --eol >tmp &&
sed -e "s/ / /g" -e "s/ */ /g" tmp >expect 2>err &&
Expand Down

0 comments on commit 95f1d71

Please sign in to comment.