Skip to content

Commit 7720dbe

Browse files
pks-tgitster
authored andcommitted
help: fix leaking return value from help_unknown_cmd()
While `help_unknown_cmd()` would usually die on an unknown command, it instead returns an autocorrected command when "help.autocorrect" is set. But while the function is declared to return a string constant, it actually returns an allocated string in that case. Callers thus aren't aware that they have to free the string, leading to a memory leak. Fix the function return type to be non-constant and free the returned value at its only callsite. Note that we cannot simply take ownership of `main_cmds.names[0]->name` and then eventually free it. This is because the `struct cmdname` is using a flex array to allocate the name, so the name pointer points into the middle of the structure and thus cannot be freed. Signed-off-by: Patrick Steinhardt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 889c597 commit 7720dbe

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

git.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -961,7 +961,9 @@ int cmd_main(int argc, const char **argv)
961961
exit(1);
962962
}
963963
if (!done_help) {
964-
strvec_replace(&args, 0, help_unknown_cmd(cmd));
964+
char *assumed = help_unknown_cmd(cmd);
965+
strvec_replace(&args, 0, assumed);
966+
free(assumed);
965967
cmd = args.v[0];
966968
done_help = 1;
967969
} else {

help.c

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@ static const char bad_interpreter_advice[] =
612612
N_("'%s' appears to be a git command, but we were not\n"
613613
"able to execute it. Maybe git-%s is broken?");
614614

615-
const char *help_unknown_cmd(const char *cmd)
615+
char *help_unknown_cmd(const char *cmd)
616616
{
617617
struct help_unknown_cmd_config cfg = { 0 };
618618
int i, n, best_similarity = 0;
@@ -695,9 +695,8 @@ const char *help_unknown_cmd(const char *cmd)
695695
; /* still counting */
696696
}
697697
if (cfg.autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
698-
const char *assumed = main_cmds.names[0]->name;
699-
main_cmds.names[0] = NULL;
700-
cmdnames_release(&main_cmds);
698+
char *assumed = xstrdup(main_cmds.names[0]->name);
699+
701700
fprintf_ln(stderr,
702701
_("WARNING: You called a Git command named '%s', "
703702
"which does not exist."),

help.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ void list_all_other_cmds(struct string_list *list);
3232
void list_cmds_by_category(struct string_list *list,
3333
const char *category);
3434
void list_cmds_by_config(struct string_list *list);
35-
const char *help_unknown_cmd(const char *cmd);
35+
char *help_unknown_cmd(const char *cmd);
3636
void load_command_list(const char *prefix,
3737
struct cmdnames *main_cmds,
3838
struct cmdnames *other_cmds);

0 commit comments

Comments
 (0)