Skip to content

Commit

Permalink
index-pack: --fsck-objects to take an optional argument for fsck msgs
Browse files Browse the repository at this point in the history
git-index-pack has a --strict mode that can take an optional argument to
provide a list of fsck issues to change their severity. --fsck-objects
does not have such a utility, which would be useful if one would like to
be more lenient or strict on data integrity in a repository.

Like --strict, Allow --fsck-objects to also take a list of fsck msgs to
change the severity.

This commit also removes the "For internal use only" note for
--fsck-objects, and documents the option. This won't often be used by
the normal end user, but it turns out it is useful for Git forges like
GitLab.

Signed-off-by: John Cai <[email protected]>
  • Loading branch information
john-cai committed Jan 24, 2024
1 parent b6cc485 commit 96d8eba
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 9 deletions.
10 changes: 8 additions & 2 deletions Documentation/git-index-pack.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,14 @@ default and "Indexing objects" when `--stdin` is specified.
--check-self-contained-and-connected::
Die if the pack contains broken links. For internal use only.

--fsck-objects::
For internal use only.
--fsck-objects[=<msg-ids>]::
Instructs index-pack to check for broken objects instead of broken
links. If `<msg-ids>` is passed, it should be a comma-separated list of
`<msg-id>=<severity>` where `<msg-id>` and `<severity>` are used to
change the severity of `fsck` errors, eg: `--strict="missingEmail=ignore,badTagName=ignore"`.
See the entry for the `fsck.<msg-id>` configuration options in
`linkgit:git-fsck[1] for more information on the possible values of
`<msg-id>` and `<severity>`.
+
Die if the pack contains broken objects. If the pack contains a tree
pointing to a .gitmodules blob that does not exist, prints the hash of
Expand Down
5 changes: 3 additions & 2 deletions builtin/index-pack.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#include "setup.h"

static const char index_pack_usage[] =
"git index-pack [-v] [-o <index-file>] [--keep | --keep=<msg>] [--[no-]rev-index] [--verify] [--strict[=<msg-ids>]] (<pack-file> | --stdin [--fix-thin] [<pack-file>])";
"git index-pack [-v] [-o <index-file>] [--keep | --keep=<msg>] [--[no-]rev-index] [--verify] [--strict[=<msg-ids>]] [--fsck-objects[=<msg-ids>]] (<pack-file> | --stdin [--fix-thin] [<pack-file>])";

struct object_entry {
struct pack_idx_entry idx;
Expand Down Expand Up @@ -1785,8 +1785,9 @@ int cmd_index_pack(int argc, const char **argv, const char *prefix)
} else if (!strcmp(arg, "--check-self-contained-and-connected")) {
strict = 1;
check_self_contained_and_connected = 1;
} else if (!strcmp(arg, "--fsck-objects")) {
} else if (skip_to_optional_arg(arg, "--fsck-objects", &arg)) {
do_fsck_object = 1;
fsck_set_msg_types(&fsck_options, arg);
} else if (!strcmp(arg, "--verify")) {
verify = 1;
} else if (!strcmp(arg, "--verify-stat")) {
Expand Down
28 changes: 23 additions & 5 deletions t/t5300-pack-object.sh
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,7 @@ test_expect_success 'index-pack with --strict' '
)
'

test_expect_success 'index-pack with --strict downgrading fsck msgs' '
test_when_finished rm -rf strict &&
test_expect_success 'setup for --strict and --fsck-objects downgrading fsck msgs' '
git init strict &&
(
cd strict &&
Expand All @@ -457,12 +456,31 @@ test_expect_success 'index-pack with --strict downgrading fsck msgs' '
EOF
git hash-object --literally -t commit -w --stdin <commit >commit_list &&
PACK=$(git pack-objects test <commit_list) &&
test_must_fail git index-pack --strict "test-$PACK.pack" &&
git index-pack --strict="missingEmail=ignore" "test-$PACK.pack"
git pack-objects test <commit_list >pack-name
)
'

test_with_bad_commit () {
opt="$1" &&
arg="$2" &&
(
cd strict &&
git index-pack "$opt"="$arg" "test-$(cat pack-name).pack"
)
}

test_expect_success 'index-pack with --strict downgrading fsck msgs' '
test_with_bad_commit --strict "missingEmail=ignore"
'

test_expect_success 'index-pack with --fsck-objects downgrading fsck msgs' '
test_with_bad_commit --fsck-objects "missingEmail=ignore"
'

test_expect_success 'cleanup for --strict and --fsck-objects downgrading fsck msgs' '
rm -rf strict
'

test_expect_success 'honor pack.packSizeLimit' '
git config pack.packSizeLimit 3m &&
packname_10=$(git pack-objects test-10 <obj-list) &&
Expand Down

0 comments on commit 96d8eba

Please sign in to comment.