Skip to content

Commit

Permalink
git: remove an early return from save_env_before_alias()
Browse files Browse the repository at this point in the history
When help.autocorrect is in effect, an attempt to auto-execute an
uniquely corrected result of a misspelt alias will result in an
irrelevant error message.  The codepath that causes this calls
save_env_before_alias() and restore_env() in handle_alias(), and
that happens twice.  A global variable orig_cwd is allocated to hold
the return value of getcwd() in save_env_before_alias(), which is
then used in restore_env() to go back to that directory and finally
free(3)'d there.

However, save_env_before_alias() is not prepared to be called twice.
It returns early when it knows it has already been called, leaving
orig_cwd undefined, which is then checked in the second call to
restore_env(), and by that time, the memory that used to hold the
contents of orig_cwd is either freed or reused to hold something
else, and this is fed to chdir(2), causing it to fail.  Even if it
did not fail (i.e. reading of the already free'd piece of memory
yielded a directory path that we can chdir(2) to), it then gets
free(3)'d.

Fix this by making sure save_env() does do the saving when called.

While at it, add a minimal test for help.autocorrect facility.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Junio C Hamano committed Jan 27, 2016
1 parent ac78663 commit 9d1d2b7
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 2 deletions.
2 changes: 0 additions & 2 deletions git.c
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ static int saved_env_before_alias;
static void save_env_before_alias(void)
{
int i;
if (saved_env_before_alias)
return;
saved_env_before_alias = 1;
orig_cwd = xgetcwd();
for (i = 0; i < ARRAY_SIZE(env_names); i++) {
Expand Down
52 changes: 52 additions & 0 deletions t/t9003-help-autocorrect.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
#!/bin/sh

test_description='help.autocorrect finding a match'
. ./test-lib.sh

test_expect_success 'setup' '
# An alias
git config alias.lgf "log --format=%s --first-parent" &&
# A random user-defined command
write_script git-distimdistim <<-EOF &&
echo distimdistim was called
EOF
PATH="$PATH:." &&
export PATH &&
git commit --allow-empty -m "a single log entry" &&
# Sanity check
git lgf >actual &&
echo "a single log entry" >expect &&
test_cmp expect actual &&
git distimdistim >actual &&
echo "distimdistim was called" >expect &&
test_cmp expect actual
'

test_expect_success 'autocorrect showing candidates' '
git config help.autocorrect 0 &&
test_must_fail git lfg 2>actual &&
sed -e "1,/^Did you mean this/d" actual | grep lgf &&
test_must_fail git distimdist 2>actual &&
sed -e "1,/^Did you mean this/d" actual | grep distimdistim
'

test_expect_success 'autocorrect running commands' '
git config help.autocorrect -1 &&
git lfg >actual &&
echo "a single log entry" >expect &&
test_cmp expect actual &&
git distimdist >actual &&
echo "distimdistim was called" >expect &&
test_cmp expect actual
'

test_done

0 comments on commit 9d1d2b7

Please sign in to comment.