show-branch: -g and --current are incompatible

When "--current" is given to "git show-branch" running in the "--reflog" mode, the code tries to reference a "reflog" message that does not even exist. This is because the --current is not prepared to work in that mode. The reason "--current" exists is to support this request: I list branches on the command line. These are the branchesI care about and I use as anchoring points. I may or may not be on one of these main branches. Please make sure I can view the commits on the current branch with respect to what is in these other branches. And to serve that request, the code checks if the current branch is among the ones listed on the command line, and adds it only if it is not to the end of one array, which essentially lists the objects. The reflog mode additionally uses another array to list reflog messages, which the "--current" code does not add to. This leaves one uninitialized slot at the end of the array of reflog messages, and causes the program to show garbage or segfault. Catch the unsupported (and meaningless) combination and exit with a usage error. There are other combinations of options that are incompatible but have not been tested. Add test to cover them while adding coverage for this new combination. Reported-by: Gregory David <gregory.david@p1sec.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed Apr 21, 2022 at 14:25 UTC 41c64ae0e762d2c4ef1ddd578b8992967547dc5f
2 files changed +18
builtin/show-branch.c
+4
@@ -711,6 +711,10 @@ int cmd_show_branch(int ac, const char **av, const char *prefix)
711 "--all/--remotes/--independent/--merge-base");
712 }
713
714 + if (with_current_branch && reflog)
715 + die(_("options '%s' and '%s' cannot be used together"),
716 + "--reflog", "--current");
717 +
718 /* If nothing is specified, show all branches by default */
719 if (ac <= topics && all_heads + all_remotes == 0)
720 all_heads = 1;
t/t3202-show-branch.sh
+14
@@ -161,4 +161,18 @@ test_expect_success 'show branch --reflog=2' '
161 test_cmp actual expect
162 '
163
164 +# incompatible options
165 +while read combo
166 +do
167 + test_expect_success "show-branch $combo (should fail)" '
168 + test_must_fail git show-branch $combo 2>error &&
169 + grep -e "cannot be used together" -e "usage:" error
170 + '
171 +done <<\EOF
172 +--all --reflog
173 +--merge-base --reflog
174 +--list --merge-base
175 +--reflog --current
176 +EOF
177 +
178 test_done