[PATCH] diagnose: require repository
- From
- Martin Ågren <martin.agren@gmail.com>
- Date
- Oct 14, 2023, 13:53 UTC
- Message-ID
- <20231014135302.13095-1-martin.agren@gmail.com>
- In-Reply-To
- <CAKFQ_Q9WjF9i-Rx2jdCw-adPVQrWNfNKrDY-em8Rpa5RNLXz4A@mail.gmail.com>
When `git diagnose` is run from outside a repo, it begins collecting various information before eventually hitting a segmentation fault, leaving an incomplete zip file behind.
Switch from the gentle setup to requiring a git directory. Without a git repo, there isn't really much to diagnose.
We could possibly do a best-effort collection of information about the machine and then give up. That would roughly be today's behavior but with a controlled exit rather than a segfault. However, the purpose of this tool is largely to create a zip archive. Rather than creating an empty zip file or no zip file at all, and having to explain that behavior, it seems more helpful to bail out clearly and early with a succinct error message.
Reported-by: ks1322 ks1322 <ks1322@gmail.com> Signed-off-by: Martin Ågren <martin.agren@gmail.com> --- Thanks for the report. This could be one way of fixing this.
I haven't found anything in the original submission [1] discussing this "_GENTLY". I didn't see anything in the implementation or the tests suggesting that it was intentional to run outside a git repo.
[1] https://lore.kernel.org/git/xmqqzgg1nz6v.fsf@gitster.g/t/#mc66904caab6bc79e57eaf5063df268b2725b6fcc
t/t0092-diagnose.sh | 5 +++++ git.c | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/t/t0092-diagnose.sh b/t/t0092-diagnose.sh index 133e5747d6..49671d35a2 100755 --- a/t/t0092-diagnose.sh +++ b/t/t0092-diagnose.sh @@ -5,6 +5,11 @@ test_description='git diagnose' TEST_PASSES_SANITIZE_LEAK=true . ./test-lib.sh +test_expect_success 'nothing to diagnose without repo' ' + nongit test_must_fail git diagnose 2>err && + grep "not a git repository" err +' + test_expect_success UNZIP 'creates diagnostics zip archive' ' test_when_finished rm -rf report && diff --git a/git.c b/git.c index c67e44dd82..ff04a74bbd 100644 --- a/git.c +++ b/git.c @@ -525,7 +525,7 @@ static struct cmd_struct commands[] = { { "credential-cache--daemon", cmd_credential_cache_daemon }, { "credential-store", cmd_credential_store }, { "describe", cmd_describe, RUN_SETUP }, - { "diagnose", cmd_diagnose, RUN_SETUP_GENTLY }, + { "diagnose", cmd_diagnose, RUN_SETUP }, { "diff", cmd_diff, NO_PARSEOPT }, { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT }, { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
-- 2.42.0.399.g85a82e71e0