git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/2] difftool: allow running outside Git worktrees with --no-index

From
Jeff King <peff@peff.net>
Date
Mar 13, 2019, 20:46 UTC
Message-ID
<20190313204644.GA5397@sigill.intra.peff.net>
In-Reply-To
<9f6eb60eeeccf920af83652899c5bc2d40e2092f.1552504812.git.gitgitgadget@gmail.com>
On Wed, Mar 13, 2019 at 12:20:14PM -0700, Johannes Schindelin via GitGitGadget wrote:
Show 9 quoted lines
> From: Johannes Schindelin <johannes.schindelin@gmx.de>
> 
> As far as this developer can tell, the conversion from a Perl script to
> a built-in caused the regression in the difftool that it no longer runs
> outside of a Git worktree (with `--no-index`, of course).
> 
> It is a bit embarrassing that it took over two years after retiring the
> Perl version to discover this regression, but at least we now know, and
> can do something, about it.
If a bug falls in the forest, does it make a sound?

I get the impression that `--no-index` is not used all that much, given how long bugs seem to hang around in it (and doubly so when intersected with the difftool).

Show 9 quoted lines
> -	setenv(GIT_DIR_ENVIRONMENT, absolute_path(get_git_dir()), 1);
> -	setenv(GIT_WORK_TREE_ENVIRONMENT, absolute_path(get_git_work_tree()), 1);
> +	for (i = 0; i < argc; i++)
> +		if (!strcmp(argv[i], "--"))
> +			break;
> +		else if (!strcmp(argv[i], "--no-index")) {
> +			no_index = 1;
> +			break;
> +		}

Instead of this ad-hoc parsing, can we just add an OPT_BOOL("no-index") to the parse-options array? We'll have already run parse_options() at this point.

We'd just have to remember to add it back to the argv of diff sub-commands we run.

Show 8 quoted lines
> +	if (!no_index && !startup_info->have_repository)
> +		die(_("difftool requires worktree or --no-index"));
> +
> +	if (!no_index){
> +		setup_work_tree();
> +		setenv(GIT_DIR_ENVIRONMENT, absolute_path(get_git_dir()), 1);
> +		setenv(GIT_WORK_TREE_ENVIRONMENT, absolute_path(get_git_work_tree()), 1);
> +	}
This part makes sense.

There may be other subtle dependencies on having a repo from sub-functions we run, but I didn't see any from a quick scan. And anyway, if there is such a code path, it is no worse off than before your patch (and in fact much better, because it would hopefully yield a BUG() that would tell us what we need to fix).

Show 9 quoted lines
> index 2014aab6b8..46365ed86a 100644
> --- a/git.c
> +++ b/git.c
> @@ -491,7 +491,7 @@ static struct cmd_struct commands[] = {
>  	{ "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
>  	{ "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
>  	{ "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
> -	{ "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
> +	{ "difftool", cmd_difftool, RUN_SETUP_GENTLY },

We necessarily lost NEED_WORK_TREE, but that's OK because you added in a setup_work_tree() in the function. Good.

Show 7 quoted lines
> +test_expect_success 'outside worktree' '
> +	mkdir outside &&
> +	echo 1 >outside/1 &&
> +	echo 2 >outside/2 &&
> +	test_expect_code 1 env GIT_CEILING_DIRECTORIES="$(pwd)" git \
> +		-c diff.tool=echo -c difftool.echo.cmd="echo \$LOCAL \$REMOTE" \
> +		-C outside difftool --no-prompt --no-index 1 2 >out &&

We have a helper for running outside a repo. Because you have to set up the "outside" space, it unfortunately doesn't shorten things as much as it does in some other spots:

diff --git a/t/t7800-difftool.sh b/t/t7800-difftool.sh
index 4907627656..255a787614 100755
--- a/t/t7800-difftool.sh
+++ b/t/t7800-difftool.sh
@@ -706,12 +706,12 @@ test_expect_success SYMLINKS 'difftool --dir-diff handles modified symlinks' '
 '
 
 test_expect_success 'outside worktree' '
-	mkdir outside &&
-	echo 1 >outside/1 &&
-	echo 2 >outside/2 &&
-	test_expect_code 1 env GIT_CEILING_DIRECTORIES="$(pwd)" git \
+	mkdir non-repo &&
+	echo 1 >non-repo/1 &&
+	echo 2 >non-repo/2 &&
+	test_expect_code 1 nongit git \
 		-c diff.tool=echo -c difftool.echo.cmd="echo \$LOCAL \$REMOTE" \
-		-C outside difftool --no-prompt --no-index 1 2 >out &&
+		difftool --no-prompt --no-index 1 2 >out &&
 	test "1 2" = "$(cat out)"
 '
 

but it might be worth using anyway, just for consistency.

> +	test "1 2" = "$(cat out)"

A minor nit, but I think:

  echo "1 2" >expect &&
  test_cmp expect actual

produces nicer output on failure, and costs the same number of
processes (it is an extra file write, but I think the main driver of
performance in the test suite is just processes).

-Peff
Previous: Johannes Schindelin via GitGitGadgetNext: Johannes Schindelin
Message 3 of 17 in “Allow difftool to be run outside of Git worktrees”
  1. 0/2 Allow difftool to be run outside of Git worktreesJohannes Schindelin via GitGitGadget, Mar 13, 2019
  2. 2/2 difftool: allow running outside Git worktrees with --no-indexJohannes Schindelin via GitGitGadget, Mar 13, 2019
  3. Jeff KingMar 13, 2019
  4. Johannes SchindelinMar 14, 2019
  5. Jeff KingMar 15, 2019
  6. 1/2 difftool: remove obsolete (and misleading) commentJohannes Schindelin via GitGitGadget, Mar 13, 2019
  7. 0/3 Allow difftool to be run outside of Git worktreesJohannes Schindelin via GitGitGadget, Mar 14, 2019
  8. 1/3 difftool: remove obsolete (and misleading) commentJohannes Schindelin via GitGitGadget, Mar 14, 2019
  9. 2/3 parse-options: make OPT_ARGUMENT() more usefulJohannes Schindelin via GitGitGadget, Mar 14, 2019
  10. Jeff KingMar 15, 2019
  11. Johannes SchindelinMar 15, 2019
  12. Junio C HamanoMar 18, 2019
  13. Jeff KingMar 18, 2019
  14. Junio C HamanoMar 19, 2019
  15. 3/3 difftool: allow running outside Git worktrees with --no-indexJohannes Schindelin via GitGitGadget, Mar 14, 2019
  16. Jeff KingMar 15, 2019
  17. Johannes SchindelinMar 15, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.