Skip to content

Commit

Permalink
maintenance: add --quiet option
Browse files Browse the repository at this point in the history
Maintenance activities are commonly used as steps in larger scripts.
Providing a '--quiet' option allows those scripts to be less noisy when
run on a terminal window. Turn this mode on by default when stderr is
not a terminal.

Pipe the option to the 'git gc' child process.

Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
derrickstolee authored and gitster committed Sep 17, 2020
1 parent 2057d75 commit 3ddaad0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
3 changes: 3 additions & 0 deletions Documentation/git-maintenance.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ OPTIONS
in the `gc.auto` config setting, or when the number of pack-files
exceeds the `gc.autoPackLimit` config setting.

--quiet::
Do not report progress or other information over `stderr`.

GIT
---
Part of the linkgit:git[1] suite
11 changes: 10 additions & 1 deletion builtin/gc.c
Original file line number Diff line number Diff line change
Expand Up @@ -701,12 +701,13 @@ int cmd_gc(int argc, const char **argv, const char *prefix)
}

static const char * const builtin_maintenance_run_usage[] = {
N_("git maintenance run [--auto]"),
N_("git maintenance run [--auto] [--[no-]quiet]"),
NULL
};

struct maintenance_run_opts {
int auto_flag;
int quiet;
};

static int maintenance_task_gc(struct maintenance_run_opts *opts)
Expand All @@ -718,6 +719,10 @@ static int maintenance_task_gc(struct maintenance_run_opts *opts)

if (opts->auto_flag)
strvec_push(&child.args, "--auto");
if (opts->quiet)
strvec_push(&child.args, "--quiet");
else
strvec_push(&child.args, "--no-quiet");

close_object_store(the_repository->objects);
return run_command(&child);
Expand All @@ -729,10 +734,14 @@ static int maintenance_run(int argc, const char **argv, const char *prefix)
struct option builtin_maintenance_run_options[] = {
OPT_BOOL(0, "auto", &opts.auto_flag,
N_("run tasks based on the state of the repository")),
OPT_BOOL(0, "quiet", &opts.quiet,
N_("do not report progress or other information over stderr")),
OPT_END()
};
memset(&opts, 0, sizeof(opts));

opts.quiet = !isatty(2);

argc = parse_options(argc, argv, prefix,
builtin_maintenance_run_options,
builtin_maintenance_run_usage,
Expand Down
15 changes: 10 additions & 5 deletions t/t7900-maintenance.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,16 @@ test_expect_success 'help text' '
test_i18ngrep "usage: git maintenance" err
'

test_expect_success 'run [--auto]' '
GIT_TRACE2_EVENT="$(pwd)/run-no-auto.txt" git maintenance run &&
GIT_TRACE2_EVENT="$(pwd)/run-auto.txt" git maintenance run --auto &&
test_subcommand git gc <run-no-auto.txt &&
test_subcommand git gc --auto <run-auto.txt
test_expect_success 'run [--auto|--quiet]' '
GIT_TRACE2_EVENT="$(pwd)/run-no-auto.txt" \
git maintenance run 2>/dev/null &&
GIT_TRACE2_EVENT="$(pwd)/run-auto.txt" \
git maintenance run --auto 2>/dev/null &&
GIT_TRACE2_EVENT="$(pwd)/run-no-quiet.txt" \
git maintenance run --no-quiet 2>/dev/null &&
test_subcommand git gc --quiet <run-no-auto.txt &&
test_subcommand git gc --auto --quiet <run-auto.txt &&
test_subcommand git gc --no-quiet <run-no-quiet.txt
'

test_done

0 comments on commit 3ddaad0

Please sign in to comment.