diff mbox series

[v2,1/3] difftool: eliminate use of global variables

Message ID 20250206042010.865947-1-davvid@gmail.com (mailing list archive)
State Accepted
Commit 8241ae63d821efc7906d13654cb63523dc4f0a3a
Headers show
Series [v2,1/3] difftool: eliminate use of global variables | expand

Commit Message

David Aguilar Feb. 6, 2025, 4:20 a.m. UTC
Move difftool's global variables into a difftools_option struct
in preparation for removal of USE_THE_REPOSITORY_VARIABLE.

Signed-off-by: David Aguilar <davvid@gmail.com>
---
 builtin/difftool.c | 51 ++++++++++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 18 deletions(-)

Comments

Elijah Newren Feb. 6, 2025, 8:29 a.m. UTC | #1
On Wed, Feb 5, 2025 at 8:20 PM David Aguilar <davvid@gmail.com> wrote:
>
> Move difftool's global variables into a difftools_option struct
> in preparation for removal of USE_THE_REPOSITORY_VARIABLE.

Thanks for splitting these out.

> Signed-off-by: David Aguilar <davvid@gmail.com>
> ---
>  builtin/difftool.c | 51 ++++++++++++++++++++++++++++++----------------
>  1 file changed, 33 insertions(+), 18 deletions(-)
>
> diff --git a/builtin/difftool.c b/builtin/difftool.c
> index 03a8bb92a9..0b6b92aee0 100644
> --- a/builtin/difftool.c
> +++ b/builtin/difftool.c
> @@ -36,18 +36,27 @@
>  #include "entry.h"
>  #include "setup.h"
>
> -static int trust_exit_code;
> -
>  static const char *const builtin_difftool_usage[] = {
>         N_("git difftool [<options>] [<commit> [<commit>]] [--] [<path>...]"),
>         NULL
>  };
>
> +struct difftool_options {
> +       int has_symlinks;
> +       int symlinks;
> +       int trust_exit_code;
> +};
> +
>  static int difftool_config(const char *var, const char *value,
>                            const struct config_context *ctx, void *cb)
>  {
> +       struct difftool_options *dt_options = (struct difftool_options *)cb;
>         if (!strcmp(var, "difftool.trustexitcode")) {
> -               trust_exit_code = git_config_bool(var, value);
> +               dt_options->trust_exit_code = git_config_bool(var, value);
> +               return 0;
> +       }
> +       if (!strcmp(var, "core.symlinks")) {
> +               dt_options->has_symlinks = git_config_bool(var, value);

It appears that the only use for has_symlinks....

>                 return 0;
>         }
>
> @@ -291,13 +300,14 @@ static int ensure_leading_directories(char *path)
>   * to compare the readlink(2) result as text, even on a filesystem that is
>   * capable of doing a symbolic link.
>   */
> -static char *get_symlink(const struct object_id *oid, const char *path)
> +static char *get_symlink(struct difftool_options *dt_options,
> +                        const struct object_id *oid, const char *path)
>  {
>         char *data;
>         if (is_null_oid(oid)) {
>                 /* The symlink is unknown to Git so read from the filesystem */
>                 struct strbuf link = STRBUF_INIT;
> -               if (has_symlinks) {
> +               if (dt_options->has_symlinks) {

Why is this based on dt_options->has_symlinks rather than dt_options->symlinks?

(I guess this question is equivalent to asking why the preimage code
was using has_symlinks, instead of the symlinks parameter set from the
command line option.  As far as I can see, has_symlinks is supposed to
merely function as a default value for symlinks in the case no command
line parameter is passed...but this is the one counter-example.  But
was it an intentional counter-example, or an accident?)

That said, fixing this, if fixing is needed, doesn't belong in this
patch; it'd probably be better as a preparatory patch.  But, it trips
up reviewers (looks like Patrick was wondering about the same thing on
v1 of your series), so it at least would probably be helpful to
mention in the commit message if no other cleanup is needed with
these.

>                         if (strbuf_readlink(&link, path, strlen(path)))
>                                 die(_("could not read symlink %s"), path);
>                 } else if (strbuf_read_file(&link, path, 128))
> @@ -355,7 +365,8 @@ static void write_standin_files(struct pair_entry *entry,
>                 write_file_in_directory(rdir, rdir_len, entry->path, entry->right);
>  }
>
> -static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
> +static int run_dir_diff(struct difftool_options *dt_options,
> +                       const char *extcmd, const char *prefix,
>                         struct child_process *child)
>  {
>         struct strbuf info = STRBUF_INIT, lpath = STRBUF_INIT;
> @@ -469,13 +480,13 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>                 }
>
>                 if (S_ISLNK(lmode)) {
> -                       char *content = get_symlink(&loid, src_path);
> +                       char *content = get_symlink(dt_options, &loid, src_path);
>                         add_left_or_right(&symlinks2, src_path, content, 0);
>                         free(content);
>                 }
>
>                 if (S_ISLNK(rmode)) {
> -                       char *content = get_symlink(&roid, dst_path);
> +                       char *content = get_symlink(dt_options, &roid, dst_path);
>                         add_left_or_right(&symlinks2, dst_path, content, 1);
>                         free(content);
>                 }
> @@ -528,7 +539,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>                                         goto finish;
>                                 }
>                                 add_path(&wtdir, wtdir_len, dst_path);
> -                               if (symlinks) {
> +                               if (dt_options->symlinks) {
>                                         if (symlink(wtdir.buf, rdir.buf)) {
>                                                 ret = error_errno("could not symlink '%s' to '%s'", wtdir.buf, rdir.buf);
>                                                 goto finish;
> @@ -614,7 +625,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>                 if (lstat(rdir.buf, &st))
>                         continue;
>
> -               if ((symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
> +               if ((dt_options->symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
>                         continue;
>
>                 if (!indices_loaded) {
> @@ -704,9 +715,13 @@ int cmd_difftool(int argc,
>                  const char *prefix,
>                  struct repository *repo UNUSED)
>  {
> -       int use_gui_tool = -1, dir_diff = 0, prompt = -1, symlinks = 0,
> -           tool_help = 0, no_index = 0;
> +       int use_gui_tool = -1, dir_diff = 0, prompt = -1, tool_help = 0, no_index = 0;
>         static char *difftool_cmd = NULL, *extcmd = NULL;
> +       struct difftool_options dt_options = {
> +               .has_symlinks = 1,
> +               .symlinks = 1,
> +               .trust_exit_code = 0
> +       };
>         struct option builtin_difftool_options[] = {
>                 OPT_BOOL('g', "gui", &use_gui_tool,
>                          N_("use `diff.guitool` instead of `diff.tool`")),
> @@ -717,14 +732,14 @@ int cmd_difftool(int argc,
>                         0, PARSE_OPT_NONEG),
>                 OPT_SET_INT_F(0, "prompt", &prompt, NULL,
>                         1, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN),
> -               OPT_BOOL(0, "symlinks", &symlinks,
> +               OPT_BOOL(0, "symlinks", &dt_options.symlinks,
>                          N_("use symlinks in dir-diff mode")),
>                 OPT_STRING('t', "tool", &difftool_cmd, N_("tool"),
>                            N_("use the specified diff tool")),
>                 OPT_BOOL(0, "tool-help", &tool_help,
>                          N_("print a list of diff tools that may be used with "
>                             "`--tool`")),
> -               OPT_BOOL(0, "trust-exit-code", &trust_exit_code,
> +               OPT_BOOL(0, "trust-exit-code", &dt_options.trust_exit_code,
>                          N_("make 'git-difftool' exit when an invoked diff "
>                             "tool returns a non-zero exit code")),
>                 OPT_STRING('x', "extcmd", &extcmd, N_("command"),
> @@ -734,8 +749,8 @@ int cmd_difftool(int argc,
>         };
>         struct child_process child = CHILD_PROCESS_INIT;
>
> -       git_config(difftool_config, NULL);
> -       symlinks = has_symlinks;
> +       git_config(difftool_config, &dt_options);
> +       dt_options.symlinks = dt_options.has_symlinks;

If the get_symlink() function should have been using
dt_options.symlinks instead of dt_options.has_symlinks, then
dt_options.has_symlinks is merely functioning as a default, but would
actually be superfluous.  A follow-up patch could remove that extra
field.

>
>         argc = parse_options(argc, argv, prefix, builtin_difftool_options,
>                              builtin_difftool_usage, PARSE_OPT_KEEP_UNKNOWN_OPT |
> @@ -783,7 +798,7 @@ int cmd_difftool(int argc,
>         }
>
>         setenv("GIT_DIFFTOOL_TRUST_EXIT_CODE",
> -              trust_exit_code ? "true" : "false", 1);
> +              dt_options.trust_exit_code ? "true" : "false", 1);
>
>         /*
>          * In directory diff mode, 'git-difftool--helper' is called once
> @@ -799,6 +814,6 @@ int cmd_difftool(int argc,
>         strvec_pushv(&child.args, argv);
>
>         if (dir_diff)
> -               return run_dir_diff(extcmd, symlinks, prefix, &child);
> +               return run_dir_diff(&dt_options, extcmd, prefix, &child);
>         return run_file_diff(prompt, prefix, &child);
>  }
> --
Junio C Hamano Feb. 6, 2025, 1:34 p.m. UTC | #2
David Aguilar <davvid@gmail.com> writes:

> Move difftool's global variables into a difftools_option struct
> in preparation for removal of USE_THE_REPOSITORY_VARIABLE.

Both may be good things, but I am puzzled by the "in preparation
for" part of the above description.  Would it require we lose these
three global variables if we wanted to pass through a repository
instance through the callchain instead of relying on implicit use of
the_repository?

Aren't these pretty much independent and orthogonal?


>
> Signed-off-by: David Aguilar <davvid@gmail.com>
> ---
>  builtin/difftool.c | 51 ++++++++++++++++++++++++++++++----------------
>  1 file changed, 33 insertions(+), 18 deletions(-)
>
> diff --git a/builtin/difftool.c b/builtin/difftool.c
> index 03a8bb92a9..0b6b92aee0 100644
> --- a/builtin/difftool.c
> +++ b/builtin/difftool.c
> @@ -36,18 +36,27 @@
>  #include "entry.h"
>  #include "setup.h"
>  
> -static int trust_exit_code;
> -
>  static const char *const builtin_difftool_usage[] = {
>  	N_("git difftool [<options>] [<commit> [<commit>]] [--] [<path>...]"),
>  	NULL
>  };
>  
> +struct difftool_options {
> +	int has_symlinks;
> +	int symlinks;
> +	int trust_exit_code;
> +};
> +
>  static int difftool_config(const char *var, const char *value,
>  			   const struct config_context *ctx, void *cb)
>  {
> +	struct difftool_options *dt_options = (struct difftool_options *)cb;
>  	if (!strcmp(var, "difftool.trustexitcode")) {
> -		trust_exit_code = git_config_bool(var, value);
> +		dt_options->trust_exit_code = git_config_bool(var, value);
> +		return 0;
> +	}
> +	if (!strcmp(var, "core.symlinks")) {
> +		dt_options->has_symlinks = git_config_bool(var, value);
>  		return 0;
>  	}
>  
> @@ -291,13 +300,14 @@ static int ensure_leading_directories(char *path)
>   * to compare the readlink(2) result as text, even on a filesystem that is
>   * capable of doing a symbolic link.
>   */
> -static char *get_symlink(const struct object_id *oid, const char *path)
> +static char *get_symlink(struct difftool_options *dt_options,
> +			 const struct object_id *oid, const char *path)
>  {
>  	char *data;
>  	if (is_null_oid(oid)) {
>  		/* The symlink is unknown to Git so read from the filesystem */
>  		struct strbuf link = STRBUF_INIT;
> -		if (has_symlinks) {
> +		if (dt_options->has_symlinks) {
>  			if (strbuf_readlink(&link, path, strlen(path)))
>  				die(_("could not read symlink %s"), path);
>  		} else if (strbuf_read_file(&link, path, 128))
> @@ -355,7 +365,8 @@ static void write_standin_files(struct pair_entry *entry,
>  		write_file_in_directory(rdir, rdir_len, entry->path, entry->right);
>  }
>  
> -static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
> +static int run_dir_diff(struct difftool_options *dt_options,
> +			const char *extcmd, const char *prefix,
>  			struct child_process *child)
>  {
>  	struct strbuf info = STRBUF_INIT, lpath = STRBUF_INIT;
> @@ -469,13 +480,13 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>  		}
>  
>  		if (S_ISLNK(lmode)) {
> -			char *content = get_symlink(&loid, src_path);
> +			char *content = get_symlink(dt_options, &loid, src_path);
>  			add_left_or_right(&symlinks2, src_path, content, 0);
>  			free(content);
>  		}
>  
>  		if (S_ISLNK(rmode)) {
> -			char *content = get_symlink(&roid, dst_path);
> +			char *content = get_symlink(dt_options, &roid, dst_path);
>  			add_left_or_right(&symlinks2, dst_path, content, 1);
>  			free(content);
>  		}
> @@ -528,7 +539,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>  					goto finish;
>  				}
>  				add_path(&wtdir, wtdir_len, dst_path);
> -				if (symlinks) {
> +				if (dt_options->symlinks) {
>  					if (symlink(wtdir.buf, rdir.buf)) {
>  						ret = error_errno("could not symlink '%s' to '%s'", wtdir.buf, rdir.buf);
>  						goto finish;
> @@ -614,7 +625,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>  		if (lstat(rdir.buf, &st))
>  			continue;
>  
> -		if ((symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
> +		if ((dt_options->symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
>  			continue;
>  
>  		if (!indices_loaded) {
> @@ -704,9 +715,13 @@ int cmd_difftool(int argc,
>  		 const char *prefix,
>  		 struct repository *repo UNUSED)
>  {
> -	int use_gui_tool = -1, dir_diff = 0, prompt = -1, symlinks = 0,
> -	    tool_help = 0, no_index = 0;
> +	int use_gui_tool = -1, dir_diff = 0, prompt = -1, tool_help = 0, no_index = 0;
>  	static char *difftool_cmd = NULL, *extcmd = NULL;
> +	struct difftool_options dt_options = {
> +		.has_symlinks = 1,
> +		.symlinks = 1,
> +		.trust_exit_code = 0
> +	};
>  	struct option builtin_difftool_options[] = {
>  		OPT_BOOL('g', "gui", &use_gui_tool,
>  			 N_("use `diff.guitool` instead of `diff.tool`")),
> @@ -717,14 +732,14 @@ int cmd_difftool(int argc,
>  			0, PARSE_OPT_NONEG),
>  		OPT_SET_INT_F(0, "prompt", &prompt, NULL,
>  			1, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN),
> -		OPT_BOOL(0, "symlinks", &symlinks,
> +		OPT_BOOL(0, "symlinks", &dt_options.symlinks,
>  			 N_("use symlinks in dir-diff mode")),
>  		OPT_STRING('t', "tool", &difftool_cmd, N_("tool"),
>  			   N_("use the specified diff tool")),
>  		OPT_BOOL(0, "tool-help", &tool_help,
>  			 N_("print a list of diff tools that may be used with "
>  			    "`--tool`")),
> -		OPT_BOOL(0, "trust-exit-code", &trust_exit_code,
> +		OPT_BOOL(0, "trust-exit-code", &dt_options.trust_exit_code,
>  			 N_("make 'git-difftool' exit when an invoked diff "
>  			    "tool returns a non-zero exit code")),
>  		OPT_STRING('x', "extcmd", &extcmd, N_("command"),
> @@ -734,8 +749,8 @@ int cmd_difftool(int argc,
>  	};
>  	struct child_process child = CHILD_PROCESS_INIT;
>  
> -	git_config(difftool_config, NULL);
> -	symlinks = has_symlinks;
> +	git_config(difftool_config, &dt_options);
> +	dt_options.symlinks = dt_options.has_symlinks;
>  
>  	argc = parse_options(argc, argv, prefix, builtin_difftool_options,
>  			     builtin_difftool_usage, PARSE_OPT_KEEP_UNKNOWN_OPT |
> @@ -783,7 +798,7 @@ int cmd_difftool(int argc,
>  	}
>  
>  	setenv("GIT_DIFFTOOL_TRUST_EXIT_CODE",
> -	       trust_exit_code ? "true" : "false", 1);
> +	       dt_options.trust_exit_code ? "true" : "false", 1);
>  
>  	/*
>  	 * In directory diff mode, 'git-difftool--helper' is called once
> @@ -799,6 +814,6 @@ int cmd_difftool(int argc,
>  	strvec_pushv(&child.args, argv);
>  
>  	if (dir_diff)
> -		return run_dir_diff(extcmd, symlinks, prefix, &child);
> +		return run_dir_diff(&dt_options, extcmd, prefix, &child);
>  	return run_file_diff(prompt, prefix, &child);
>  }
Elijah Newren Feb. 6, 2025, 6:08 p.m. UTC | #3
On Thu, Feb 6, 2025 at 5:34 AM Junio C Hamano <gitster@pobox.com> wrote:
>
> David Aguilar <davvid@gmail.com> writes:
>
> > Move difftool's global variables into a difftools_option struct
> > in preparation for removal of USE_THE_REPOSITORY_VARIABLE.
>
> Both may be good things, but I am puzzled by the "in preparation
> for" part of the above description.  Would it require we lose these
> three global variables if we wanted to pass through a repository
> instance through the callchain instead of relying on implicit use of
> the_repository?
>
> Aren't these pretty much independent and orthogonal?

The declaration of 'extern int has_symlinks;' in environment.h is
guarded by an #ifdef USE_THE_REPOSITORY_VARIABLE, so if you want to
stop declaring that, you need to both pass a repository through and
stop using that global variable.  (The change to trust_exit_code and
symlinks vars do seem to be independent, but kind of make sense to
handle at the same time you are changing how has_symlinks is treated.)
Junio C Hamano Feb. 6, 2025, 7:07 p.m. UTC | #4
Elijah Newren <newren@gmail.com> writes:

> stop using that global variable.  (The change to trust_exit_code and
> symlinks vars do seem to be independent, but kind of make sense to
> handle at the same time you are changing how has_symlinks is treated.)

Fair enough.  Thanks.
David Aguilar Feb. 7, 2025, 4:44 a.m. UTC | #5
On Thu, Feb 06, 2025 at 12:29:46AM -0800, Elijah Newren wrote:
> On Wed, Feb 5, 2025 at 8:20 PM David Aguilar <davvid@gmail.com> wrote:
> > diff --git a/builtin/difftool.c b/builtin/difftool.c
> > index 03a8bb92a9..0b6b92aee0 100644
> > --- a/builtin/difftool.c
> > +++ b/builtin/difftool.c
> > @@ -36,18 +36,27 @@
> >  #include "entry.h"
> >  #include "setup.h"
> >
> > -static int trust_exit_code;
> > -
> >  static const char *const builtin_difftool_usage[] = {
> >         N_("git difftool [<options>] [<commit> [<commit>]] [--] [<path>...]"),
> >         NULL
> >  };
> >
> > +struct difftool_options {
> > +       int has_symlinks;
> > +       int symlinks;
> > +       int trust_exit_code;
> > +};
> > +
> >  static int difftool_config(const char *var, const char *value,
> >                            const struct config_context *ctx, void *cb)
> >  {
> > +       struct difftool_options *dt_options = (struct difftool_options *)cb;
> >         if (!strcmp(var, "difftool.trustexitcode")) {
> > -               trust_exit_code = git_config_bool(var, value);
> > +               dt_options->trust_exit_code = git_config_bool(var, value);
> > +               return 0;
> > +       }
> > +       if (!strcmp(var, "core.symlinks")) {
> > +               dt_options->has_symlinks = git_config_bool(var, value);
> 
> It appears that the only use for has_symlinks....
> 
> >                 return 0;
> >         }
> >
> > @@ -291,13 +300,14 @@ static int ensure_leading_directories(char *path)
> >   * to compare the readlink(2) result as text, even on a filesystem that is
> >   * capable of doing a symbolic link.
> >   */
> > -static char *get_symlink(const struct object_id *oid, const char *path)
> > +static char *get_symlink(struct difftool_options *dt_options,
> > +                        const struct object_id *oid, const char *path)
> >  {
> >         char *data;
> >         if (is_null_oid(oid)) {
> >                 /* The symlink is unknown to Git so read from the filesystem */
> >                 struct strbuf link = STRBUF_INIT;
> > -               if (has_symlinks) {
> > +               if (dt_options->has_symlinks) {
> 
> Why is this based on dt_options->has_symlinks rather than dt_options->symlinks?
> 
> (I guess this question is equivalent to asking why the preimage code
> was using has_symlinks, instead of the symlinks parameter set from the
> command line option.  As far as I can see, has_symlinks is supposed to
> merely function as a default value for symlinks in the case no command
> line parameter is passed...but this is the one counter-example.  But
> was it an intentional counter-example, or an accident?)
> 
> That said, fixing this, if fixing is needed, doesn't belong in this
> patch; it'd probably be better as a preparatory patch.  But, it trips
> up reviewers (looks like Patrick was wondering about the same thing on
> v1 of your series), so it at least would probably be helpful to
> mention in the commit message if no other cleanup is needed with
> these.

Agreed. If we fix this it should be done in a separate patch and
we can explain why they were separate variables as part of that
commit message. I don't necessarily agree that it belongs in this patch.

Combining these two fields leads to test errors which is why
it wasn't touched in this round.


> > @@ -734,8 +749,8 @@ int cmd_difftool(int argc,
> >         };
> >         struct child_process child = CHILD_PROCESS_INIT;
> >
> > -       git_config(difftool_config, NULL);
> > -       symlinks = has_symlinks;
> > +       git_config(difftool_config, &dt_options);
> > +       dt_options.symlinks = dt_options.has_symlinks;
> 
> If the get_symlink() function should have been using
> dt_options.symlinks instead of dt_options.has_symlinks, then
> dt_options.has_symlinks is merely functioning as a default, but would
> actually be superfluous.  A follow-up patch could remove that extra
> field.

`has_symlinks` is currently providing both a default value and
controlling the behavior of the dir-diff mode, so it's not quite
merely functioning as a default.

My eyes gloss over comments because I completely missed the following
explanation in the comment above `get_symlink()`.
This comment explain why we have a separate `have_symlinks` field:

/*
 * Unconditional writing of a plain regular file is what
 * "git difftool --dir-diff" wants to do for symlinks.  We are preparing two
 * temporary directories to be fed to a Git-unaware tool that knows how to
 * show a diff of two directories (e.g. "diff -r A B").
 *
 * Because the tool is Git-unaware, if a symbolic link appears in either of
 * these temporary directories, it will try to dereference and show the
 * difference of the target of the symbolic link, which is not what we want,
 * as the goal of the dir-diff mode is to produce an output that is logically
 * equivalent to what "git diff" produces.
 *
 * Most importantly, we want to get textual comparison of the result of the
 * readlink(2).  get_symlink() provides that---it returns the contents of
 * the symlink that gets written to a regular file to force the external tool
 * to compare the readlink(2) result as text, even on a filesystem that is
 * capable of doing a symbolic link.
 */

In other words, we intetionally take the extra step to readlink(2)
symlinks in the dir-diff mode irrespective of the command-line option on
systems that support symlinks. That's why `has_symlinks` has to be
tracked separately.

In light of this, I suspect that we won't be combining these fields
because this behavior is intentional and necessary.

`git blame` claims that I wrote this comment 8 years ago, but that's
news to me!

Thanks for the thorough review. I'm not planning a re-roll since it
seems like this is fine as-is, but let me know if y'all feel otherwise.

One thing I would maybe change would be to rename `dt_options` to
`options`, but I also appreciate the verbosity of the dt_ prefix.

Interestingly, the `struct difftool_state` and `dt_state` names in the
original patch were chosen because the struct contained more than just
options. Specifically, it contains the `has_symlinks` field.
I'm not really sure it's worth splitting hairs over that detail,
but I'm all ears. struct difftool_options doesn't really bother me.

cheers,
Patrick Steinhardt Feb. 7, 2025, 6:28 a.m. UTC | #6
On Thu, Feb 06, 2025 at 10:08:29AM -0800, Elijah Newren wrote:
> On Thu, Feb 6, 2025 at 5:34 AM Junio C Hamano <gitster@pobox.com> wrote:
> >
> > David Aguilar <davvid@gmail.com> writes:
> >
> > > Move difftool's global variables into a difftools_option struct
> > > in preparation for removal of USE_THE_REPOSITORY_VARIABLE.
> >
> > Both may be good things, but I am puzzled by the "in preparation
> > for" part of the above description.  Would it require we lose these
> > three global variables if we wanted to pass through a repository
> > instance through the callchain instead of relying on implicit use of
> > the_repository?
> >
> > Aren't these pretty much independent and orthogonal?
> 
> The declaration of 'extern int has_symlinks;' in environment.h is
> guarded by an #ifdef USE_THE_REPOSITORY_VARIABLE, so if you want to
> stop declaring that, you need to both pass a repository through and
> stop using that global variable.  (The change to trust_exit_code and
> symlinks vars do seem to be independent, but kind of make sense to
> handle at the same time you are changing how has_symlinks is treated.)

Ah, that makes sense. It raises the question whether the refactoring
thus breaks something because we don't use that global variable anymore,
e.g. if we were munging it in the preimage. But as far as I can see we
don't modify it at all, so this should be fine.

Patrick
diff mbox series

Patch

diff --git a/builtin/difftool.c b/builtin/difftool.c
index 03a8bb92a9..0b6b92aee0 100644
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -36,18 +36,27 @@ 
 #include "entry.h"
 #include "setup.h"
 
-static int trust_exit_code;
-
 static const char *const builtin_difftool_usage[] = {
 	N_("git difftool [<options>] [<commit> [<commit>]] [--] [<path>...]"),
 	NULL
 };
 
+struct difftool_options {
+	int has_symlinks;
+	int symlinks;
+	int trust_exit_code;
+};
+
 static int difftool_config(const char *var, const char *value,
 			   const struct config_context *ctx, void *cb)
 {
+	struct difftool_options *dt_options = (struct difftool_options *)cb;
 	if (!strcmp(var, "difftool.trustexitcode")) {
-		trust_exit_code = git_config_bool(var, value);
+		dt_options->trust_exit_code = git_config_bool(var, value);
+		return 0;
+	}
+	if (!strcmp(var, "core.symlinks")) {
+		dt_options->has_symlinks = git_config_bool(var, value);
 		return 0;
 	}
 
@@ -291,13 +300,14 @@  static int ensure_leading_directories(char *path)
  * to compare the readlink(2) result as text, even on a filesystem that is
  * capable of doing a symbolic link.
  */
-static char *get_symlink(const struct object_id *oid, const char *path)
+static char *get_symlink(struct difftool_options *dt_options,
+			 const struct object_id *oid, const char *path)
 {
 	char *data;
 	if (is_null_oid(oid)) {
 		/* The symlink is unknown to Git so read from the filesystem */
 		struct strbuf link = STRBUF_INIT;
-		if (has_symlinks) {
+		if (dt_options->has_symlinks) {
 			if (strbuf_readlink(&link, path, strlen(path)))
 				die(_("could not read symlink %s"), path);
 		} else if (strbuf_read_file(&link, path, 128))
@@ -355,7 +365,8 @@  static void write_standin_files(struct pair_entry *entry,
 		write_file_in_directory(rdir, rdir_len, entry->path, entry->right);
 }
 
-static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
+static int run_dir_diff(struct difftool_options *dt_options,
+			const char *extcmd, const char *prefix,
 			struct child_process *child)
 {
 	struct strbuf info = STRBUF_INIT, lpath = STRBUF_INIT;
@@ -469,13 +480,13 @@  static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
 		}
 
 		if (S_ISLNK(lmode)) {
-			char *content = get_symlink(&loid, src_path);
+			char *content = get_symlink(dt_options, &loid, src_path);
 			add_left_or_right(&symlinks2, src_path, content, 0);
 			free(content);
 		}
 
 		if (S_ISLNK(rmode)) {
-			char *content = get_symlink(&roid, dst_path);
+			char *content = get_symlink(dt_options, &roid, dst_path);
 			add_left_or_right(&symlinks2, dst_path, content, 1);
 			free(content);
 		}
@@ -528,7 +539,7 @@  static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
 					goto finish;
 				}
 				add_path(&wtdir, wtdir_len, dst_path);
-				if (symlinks) {
+				if (dt_options->symlinks) {
 					if (symlink(wtdir.buf, rdir.buf)) {
 						ret = error_errno("could not symlink '%s' to '%s'", wtdir.buf, rdir.buf);
 						goto finish;
@@ -614,7 +625,7 @@  static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
 		if (lstat(rdir.buf, &st))
 			continue;
 
-		if ((symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
+		if ((dt_options->symlinks && S_ISLNK(st.st_mode)) || !S_ISREG(st.st_mode))
 			continue;
 
 		if (!indices_loaded) {
@@ -704,9 +715,13 @@  int cmd_difftool(int argc,
 		 const char *prefix,
 		 struct repository *repo UNUSED)
 {
-	int use_gui_tool = -1, dir_diff = 0, prompt = -1, symlinks = 0,
-	    tool_help = 0, no_index = 0;
+	int use_gui_tool = -1, dir_diff = 0, prompt = -1, tool_help = 0, no_index = 0;
 	static char *difftool_cmd = NULL, *extcmd = NULL;
+	struct difftool_options dt_options = {
+		.has_symlinks = 1,
+		.symlinks = 1,
+		.trust_exit_code = 0
+	};
 	struct option builtin_difftool_options[] = {
 		OPT_BOOL('g', "gui", &use_gui_tool,
 			 N_("use `diff.guitool` instead of `diff.tool`")),
@@ -717,14 +732,14 @@  int cmd_difftool(int argc,
 			0, PARSE_OPT_NONEG),
 		OPT_SET_INT_F(0, "prompt", &prompt, NULL,
 			1, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN),
-		OPT_BOOL(0, "symlinks", &symlinks,
+		OPT_BOOL(0, "symlinks", &dt_options.symlinks,
 			 N_("use symlinks in dir-diff mode")),
 		OPT_STRING('t', "tool", &difftool_cmd, N_("tool"),
 			   N_("use the specified diff tool")),
 		OPT_BOOL(0, "tool-help", &tool_help,
 			 N_("print a list of diff tools that may be used with "
 			    "`--tool`")),
-		OPT_BOOL(0, "trust-exit-code", &trust_exit_code,
+		OPT_BOOL(0, "trust-exit-code", &dt_options.trust_exit_code,
 			 N_("make 'git-difftool' exit when an invoked diff "
 			    "tool returns a non-zero exit code")),
 		OPT_STRING('x', "extcmd", &extcmd, N_("command"),
@@ -734,8 +749,8 @@  int cmd_difftool(int argc,
 	};
 	struct child_process child = CHILD_PROCESS_INIT;
 
-	git_config(difftool_config, NULL);
-	symlinks = has_symlinks;
+	git_config(difftool_config, &dt_options);
+	dt_options.symlinks = dt_options.has_symlinks;
 
 	argc = parse_options(argc, argv, prefix, builtin_difftool_options,
 			     builtin_difftool_usage, PARSE_OPT_KEEP_UNKNOWN_OPT |
@@ -783,7 +798,7 @@  int cmd_difftool(int argc,
 	}
 
 	setenv("GIT_DIFFTOOL_TRUST_EXIT_CODE",
-	       trust_exit_code ? "true" : "false", 1);
+	       dt_options.trust_exit_code ? "true" : "false", 1);
 
 	/*
 	 * In directory diff mode, 'git-difftool--helper' is called once
@@ -799,6 +814,6 @@  int cmd_difftool(int argc,
 	strvec_pushv(&child.args, argv);
 
 	if (dir_diff)
-		return run_dir_diff(extcmd, symlinks, prefix, &child);
+		return run_dir_diff(&dt_options, extcmd, prefix, &child);
 	return run_file_diff(prompt, prefix, &child);
 }