diff mbox series

[v4] git gui: add directly calling merge tool from configuration

Message ID pull.1773.v4.git.1726064619705.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v4] git gui: add directly calling merge tool from configuration | expand

Commit Message

tobias.boesch@miele.com Sept. 11, 2024, 2:23 p.m. UTC 
From: Tobias Boesch <tobias.boesch@miele.com>

git gui can open a merge tool when conflicts are detected (Right click
in the diff of the file with conflicts).
The merge tools that are allowed to use are hard coded into git gui.

If one wants to add a new merge tool it has to be added to git gui
through a source code change.
This is not convenient in comparison to how it works in git (without gui).

git itself has configuration options for a merge tools path and command
in the git configuration.
New merge tools can be set up there without a source code change.

Those options are used only by pure git in contrast to git gui. git calls
the configured merge tools directly from the configuration while git Gui
doesn't.

With this change git gui can call merge tools configured in the
configuration directly without a change in git gui source code.
It needs a configured "merge.tool" and a configured
"mergetool.<mergetool name>.cmd" configuration entry as shown in the
git-config manual page.

Configuration example:
[merge]
	tool = vscode
[mergetool "vscode"]
	path = the/path/to/Code.exe
	cmd = \"Code.exe\" --wait --merge \"$LOCAL\" \"$REMOTE\" \"$BASE\" \"$MERGED\"

Without the "mergetool.cmd" configuration and an unsupported "merge.tool"
entry, git gui behaves mainly as before this change and informs the user
about an unsupported merge tool. In addtition it also shows a hint to add
a configuration entry to use the tool as an unsupported tool with degraded
support.

If a wrong "mergetool.cmd" is configured by accident, it gets handled
by git gui already. In this case git gui informs the user that the merge
tool couldn't be opened. This behavior is preserved by this change and
should not change.

"Beyond Compare 3" and "Visual Studio Code" were tested as manually
configured merge tools.

Signed-off-by: Tobias Boesch <tobias.boesch@miele.com>
---
    git gui: add directly calling merge tool from gitconfig
    
    cc: Johannes Sixt j6t@kdbg.org
    
    Changes since v1:
    
     * Used existing option mergetool.cmd in gitconfig to trigger the direct
       call of the merge tool configured in the config instead adding a new
       option mergeToolFromConfig
     * Removed assignment of merge tool path to a variable and reused the
       already existing one: merget_tool_path
     * Changed formatting of the commit message
     * Added more context and an examples to the commit message
    
    Changes since v2:
    
     * Changed commit ident
     * Added hint to add a mergetool as an unsupprted tool
     * Minor typos
     * Highlighted proper nouns in commit message
     * Only using mergetool.cmd now - not using mergetool.path anymore
     * Removed gitconfig term in user message
     * Changed lines length of commit message
     * tcl commands in mergetool.cmd are now detected and not executed
       anymore
     * mergetool.cmd string parts are now substituted as list, not as a
       whole string
     * Made a more clear user hint on how to configure an unsupported
       mergetool
    
    Changes since v3:
    
     * Corrected wrong configuration option in commit message
     * Replaced "config" and "gitconfig" with "configuration" in commit
       message
     * Initialised cmdline list before appending values in loop
     * Removed hint that unsupported tools have degraded support
     * Changed popup message formatting in the popup and in the source code

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1773%2FToBoMi%2Fadd_merge_tool_from_config_file-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1773/ToBoMi/add_merge_tool_from_config_file-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/1773

Range-diff vs v3:

 1:  c8c0107ddc5 ! 1:  b5db8997b76 git gui: add directly calling merge tool from gitconfig
     @@ Metadata
      Author: Tobias Boesch <tobias.boesch@miele.com>
      
       ## Commit message ##
     -    git gui: add directly calling merge tool from gitconfig
     +    git gui: add directly calling merge tool from configuration
      
          git gui can open a merge tool when conflicts are detected (Right click
          in the diff of the file with conflicts).
     @@ Commit message
          This is not convenient in comparison to how it works in git (without gui).
      
          git itself has configuration options for a merge tools path and command
     -    in the git config.
     +    in the git configuration.
          New merge tools can be set up there without a source code change.
      
          Those options are used only by pure git in contrast to git gui. git calls
     -    the configured merge tools directly from the config while git Gui doesn't.
     +    the configured merge tools directly from the configuration while git Gui
     +    doesn't.
      
     -    With this change git gui can call merge tools configured in the gitconfig
     -    directly without a change in git gui source code.
     -    It needs a configured merge.tool and a configured mergetool.cmd config
     -    entry.
     +    With this change git gui can call merge tools configured in the
     +    configuration directly without a change in git gui source code.
     +    It needs a configured "merge.tool" and a configured
     +    "mergetool.<mergetool name>.cmd" configuration entry as shown in the
     +    git-config manual page.
      
     -    gitconfig example:
     +    Configuration example:
          [merge]
                  tool = vscode
          [mergetool "vscode"]
                  path = the/path/to/Code.exe
                  cmd = \"Code.exe\" --wait --merge \"$LOCAL\" \"$REMOTE\" \"$BASE\" \"$MERGED\"
      
     -    Without the mergetool.cmd configuration and an unsupported merge.tool
     +    Without the "mergetool.cmd" configuration and an unsupported "merge.tool"
          entry, git gui behaves mainly as before this change and informs the user
          about an unsupported merge tool. In addtition it also shows a hint to add
     -    a config entry to use the tool as an unsupported tool with degraded
     +    a configuration entry to use the tool as an unsupported tool with degraded
          support.
      
     -    If a wrong mergetool.cmd is configured by accident, it gets handled
     +    If a wrong "mergetool.cmd" is configured by accident, it gets handled
          by git gui already. In this case git gui informs the user that the merge
          tool couldn't be opened. This behavior is preserved by this change and
          should not change.
     @@ git-gui/lib/mergetool.tcl: proc merge_resolve_tool2 {} {
      +		set tool_cmd [get_config mergetool.$tool.cmd]
      +		if {$tool_cmd ne {}} {
      +			if {([string first {[} $tool_cmd] != -1) || ([string first {]} $tool_cmd] != -1)} {
     -+				error_popup [mc "Unable to process square brackets in mergetool.cmd configuration option.\
     -+								Please remove the square brackets."]
     ++				error_popup [mc "Unable to process square brackets in mergetool.$tool.cmd configuration option.
     ++
     ++Please remove the square brackets."]
      +				return
      +			} else {
     ++				set cmdline {}
      +				foreach command_part $tool_cmd {
      +					lappend cmdline [subst -nobackslashes -nocommands $command_part]
      +				}
      +			}
      +		} else {
     -+			error_popup [mc "Unsupported merge tool '%s'.\n
     -+							Currently unsupported tools can be added and used as unsupported tools with degraded support\
     -+							by adding the command of the tool to the \"mergetool.cmd\" option in the config.
     -+							See the configuration documentation for more details." $tool]
     ++			error_popup [mc "Unsupported merge tool '%s'.
     ++							
     ++To use this tool, configure \"mergetool.%s.cmd\" as shown in the git-config\
     ++manual page." $tool $tool]
      +			return
      +		}
       	}


 git-gui/lib/mergetool.tcl | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)


base-commit: c5ee8f2d1c9d336e0a46139bd35236d4a0bb93ff
diff mbox series

Patch

diff --git a/git-gui/lib/mergetool.tcl b/git-gui/lib/mergetool.tcl
index e688b016ef6..2afc875ea0a 100644
--- a/git-gui/lib/mergetool.tcl
+++ b/git-gui/lib/mergetool.tcl
@@ -272,8 +272,26 @@  proc merge_resolve_tool2 {} {
 		}
 	}
 	default {
-		error_popup [mc "Unsupported merge tool '%s'" $tool]
-		return
+		set tool_cmd [get_config mergetool.$tool.cmd]
+		if {$tool_cmd ne {}} {
+			if {([string first {[} $tool_cmd] != -1) || ([string first {]} $tool_cmd] != -1)} {
+				error_popup [mc "Unable to process square brackets in mergetool.$tool.cmd configuration option.
+
+Please remove the square brackets."]
+				return
+			} else {
+				set cmdline {}
+				foreach command_part $tool_cmd {
+					lappend cmdline [subst -nobackslashes -nocommands $command_part]
+				}
+			}
+		} else {
+			error_popup [mc "Unsupported merge tool '%s'.
+							
+To use this tool, configure \"mergetool.%s.cmd\" as shown in the git-config\
+manual page." $tool $tool]
+			return
+		}
 	}
 	}