gc -h: show usage even with broken configuration

Given a request for command-line usage information rather than some
more substantial action, the only friendly thing to do is to report
the usage information as soon as possible and exit.

Without this change, as "git gc" glances over the repository, it can
be distracted by the desire to report a malformed configuration file.

Noticed while working through reports from Duy's repository access
checker.

[jn: with rewritten log message and tests]

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/gc.c b/builtin/gc.c
index c304638b7845601f184149d3c48cbc1ea1e195f5..93deed5153d6a11d15d90353950eae3a837a7074 100644 (file)
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -189,6 +189,9 @@ int cmd_gc(int argc, const char **argv, const char *prefix)
                OPT_END()
        };
 
+       if (argc == 2 && !strcmp(argv[1], "-h"))
+               usage_with_options(builtin_gc_usage, builtin_gc_options);
+
        git_config(gc_config, NULL);
 
        if (pack_refs < 0)

diff --git a/t/t6500-gc.sh b/t/t6500-gc.sh
new file mode 100755 (executable)
index 0000000..82f3639
--- /dev/null
+++ b/t/t6500-gc.sh
@@ -0,0 +1,28 @@
+#!/bin/sh
+
+test_description='basic git gc tests
+'
+
+. ./test-lib.sh
+
+test_expect_success 'gc empty repository' '
+       git gc
+'
+
+test_expect_success 'gc --gobbledegook' '
+       test_expect_code 129 git gc --nonsense 2>err &&
+       grep "[Uu]sage: git gc" err
+'
+
+test_expect_success 'gc -h with invalid configuration' '
+       mkdir broken &&
+       (
+               cd broken &&
+               git init &&
+               echo "[gc] pruneexpire = CORRUPT" >>.git/config &&
+               test_expect_code 129 git gc -h >usage 2>&1
+       ) &&
+       grep "[Uu]sage" broken/usage
+'
+
+test_done