builtin/shortlog: explicitly set hash algo when there is no repo

Whilst git-shortlog(1) does not explicitly need any repository information when run without reference to one, it still parses some of its arguments with parse_revision_opt() which assumes that the hash algorithm is set. However, in c8aed5e8da (repository: stop setting SHA1 as the default object hash, 2024-05-07) we stopped setting up a default hash algorithm and instead require commands to set it up explicitly. This was done for most other commands like in ab274909d4 (builtin/diff: explicitly set hash algo when there is no repo, 2024-05-07) but was missed for builtin/shortlog, making git-shortlog(1) segfault outside of a repository when given arguments like --author that trigger a call to parse_revision_opt(). Fix this for now by explicitly setting the hash algorithm to SHA1. Also add a regression test for the segfault. Thanks-to: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Wolfgang Müller <wolf@oriole.systems> Signed-off-by: Taylor Blau <me@ttaylorr.com>

Wolfgang Müller committed Oct 17, 2024 at 11:35 UTC b33001645e9a1b042f5bc843b76e0e8a28a91223
2 files changed +16
builtin/shortlog.c
+12
@@ -407,6 +407,18 @@ int cmd_shortlog(int argc,
407
408 struct parse_opt_ctx_t ctx;
409
410 + /*
411 + * NEEDSWORK: Later on we'll call parse_revision_opt which relies on
412 + * the hash algorithm being set but since we are operating outside of a
413 + * Git repository we cannot determine one. This is only needed because
414 + * parse_revision_opt expects hexsz for --abbrev which is irrelevant
415 + * for shortlog outside of a git repository. For now explicitly set
416 + * SHA1, but ideally the parsing machinery would be split between
417 + * git/nongit so that we do not have to do this.
418 + */
419 + if (nongit && !the_hash_algo)
420 + repo_set_hash_algo(the_repository, GIT_HASH_SHA1);
421 +
422 git_config(git_default_config, NULL);
423 shortlog_init(&log);
424 repo_init_revisions(the_repository, &rev, prefix);
t/t4201-shortlog.sh
+4
@@ -143,6 +143,10 @@ test_expect_success 'shortlog from non-git directory refuses extra arguments' '
143 test_grep "too many arguments" out
144 '
145
146 +test_expect_success 'shortlog --author from non-git directory does not segfault' '
147 + nongit git shortlog --author=author </dev/null
148 +'
149 +
150 test_expect_success 'shortlog should add newline when input line matches wraplen' '
151 cat >expect <<\EOF &&
152 A U Thor (2):