| Message ID | pull.1373.v2.git.git.1667073374852.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 0918d0888767d42a7232b110f5ec510945256b7e |
| Headers | show |
| Series | [v2] help.c: fix autocorrect in work tree for bare repository | expand |
On Sat, 29 Oct 2022 at 21:56, Simon Gerber via GitGitGadget <gitgitgadget@gmail.com> wrote: > > [commit message omitted] > --- > Fix autocorrect in work tree for bare repository > > Currently, auto correction doesn't work reliably for commands which must > run in a work tree (e.g. git status) in Git work trees which are created > from a bare repository. > > This patch adds a test case illustrating the issue and proposes a fix > which adjusts the usage of read_early_config() in help_unknown_cmd() to > match other usages of read_early_config(). In particular the patch > removes the call to git_default_config() in the read config callback. > > Changes since v1 (both suggested by Junio): > > * Moved test to 9003 > * Squashed change and test into a single commit > > [diff omitted] Hi all, Just wanted to check what the state on this patch is (side-note: I just noticed that I didn't cc Junio in the v2 submission, my apologies). As described in the quote (and the parent email), the patch fixes how auto correct initializes the config. Version 2 addresses the points raised on v1, in particular, I've moved the test to 9003, and have squashed the change into a single commit. Please let me know if further changes are necessary. -- Simon
"Simon Gerber via GitGitGadget" <gitgitgadget@gmail.com> writes: > Calling `git_default_config()` in this callback to `read_early_config()` > seems like a bad idea since those calls will initialize a bunch of state > in `environment.c` (among other things `is_bare_repository_cfg`) before > we've properly detected that we're running in a work tree. > > All other callbacks provided to `read_early_config()` appear to only > extract their configurations while simply returning `0` for all other > config keys. Very good observation and justification for this change. > help.c | 2 +- > t/t9003-help-autocorrect.sh | 6 ++++++ > 2 files changed, 7 insertions(+), 1 deletion(-) > > diff --git a/help.c b/help.c > index d04542d8261..ae534ff0bae 100644 > --- a/help.c > +++ b/help.c > @@ -563,7 +563,7 @@ static int git_unknown_cmd_config(const char *var, const char *value, void *cb) > if (skip_prefix(var, "alias.", &p)) > add_cmdname(&aliases, p, strlen(p)); > > - return git_default_config(var, value, cb); > + return 0; > } And this is exactly what the proposed log message promises to do. > static int levenshtein_compare(const void *p1, const void *p2) > diff --git a/t/t9003-help-autocorrect.sh b/t/t9003-help-autocorrect.sh > index f00deaf3815..f5b6b4f746b 100755 > --- a/t/t9003-help-autocorrect.sh > +++ b/t/t9003-help-autocorrect.sh > @@ -60,4 +60,10 @@ test_expect_success 'autocorrect can be declined altogether' ' > test_line_count = 1 actual > ' > > +test_expect_success 'autocorrect works in work tree created from bare repo' ' > + git clone --bare . bare.git && > + git -C bare.git worktree add ../worktree && > + git -C worktree -c help.autocorrect=immediate stauts The reason why this third line is a sufficient test is...? If "status" is invoked successfully, it would not exit with non-zero status as long as it correctly notices that it was invoked in a worktree (as opposed to the current code without your fix, which would say "nah, where you are running there is no worktree", that is incorrect), but one scenario I am a bit worried about is what if the tester has an entry on $PATH that has "git-static" or whatever that is similar enough to "status", to cause autocorrect work differently from the case where "git status" would be the only plausible case. But then we can tell such a tester "don't do that, then" ;-) Let's queue the patch as-is and see what others think. Thanks. > +' > + > test_done
On Tue, 13 Dec 2022 at 02:37, Junio C Hamano <gitster@pobox.com> wrote: > > "Simon Gerber via GitGitGadget" <gitgitgadget@gmail.com> writes: > > > --- a/t/t9003-help-autocorrect.sh > > +++ b/t/t9003-help-autocorrect.sh > > @@ -60,4 +60,10 @@ test_expect_success 'autocorrect can be declined altogether' ' > > test_line_count = 1 actual > > ' > > > > +test_expect_success 'autocorrect works in work tree created from bare repo' ' > > + git clone --bare . bare.git && > > + git -C bare.git worktree add ../worktree && > > + git -C worktree -c help.autocorrect=immediate stauts > > The reason why this third line is a sufficient test is...? > > If "status" is invoked successfully, it would not exit with non-zero > status as long as it correctly notices that it was invoked in a > worktree (as opposed to the current code without your fix, which > would say "nah, where you are running there is no worktree", that is > incorrect), but one scenario I am a bit worried about is what if the > tester has an entry on $PATH that has "git-static" or whatever that > is similar enough to "status", to cause autocorrect work differently > from the case where "git status" would be the only plausible case. Thanks for pointing out that autocorrect could work differently for a tester depending on what's in their path. I didn't consider that case at all. > > But then we can tell such a tester "don't do that, then" ;-) I think that's fine in this case. > > Let's queue the patch as-is and see what others think. Awesome, thanks > > Thanks. > > > +' > > + > > test_done >
diff --git a/help.c b/help.c index d04542d8261..ae534ff0bae 100644 --- a/help.c +++ b/help.c @@ -563,7 +563,7 @@ static int git_unknown_cmd_config(const char *var, const char *value, void *cb) if (skip_prefix(var, "alias.", &p)) add_cmdname(&aliases, p, strlen(p)); - return git_default_config(var, value, cb); + return 0; } static int levenshtein_compare(const void *p1, const void *p2) diff --git a/t/t9003-help-autocorrect.sh b/t/t9003-help-autocorrect.sh index f00deaf3815..f5b6b4f746b 100755 --- a/t/t9003-help-autocorrect.sh +++ b/t/t9003-help-autocorrect.sh @@ -60,4 +60,10 @@ test_expect_success 'autocorrect can be declined altogether' ' test_line_count = 1 actual ' +test_expect_success 'autocorrect works in work tree created from bare repo' ' + git clone --bare . bare.git && + git -C bare.git worktree add ../worktree && + git -C worktree -c help.autocorrect=immediate stauts +' + test_done