diff mbox series

[v11] Support auto-merge for meld to follow the vim-diff behavior

Message ID pull.781.v11.git.git.1594106024078.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v11] Support auto-merge for meld to follow the vim-diff behavior | expand

Commit Message

Johannes Schindelin via GitGitGadget July 7, 2020, 7:13 a.m. UTC
From: Lin Sun <lin.sun@zoom.us>

Make the mergetool used with "meld" backend behave similarly to "vimdiff" by
telling it to auto-merge non-conflicting parts and highlight the conflicting
parts when `mergetool.meld.useAutoMerge` is configured with `true`, or `auto`
for detecting the `--auto-merge` option automatically.

Helped-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
Helped-by: David Aguilar <davvid@gmail.com>
Signed-off-by: Lin Sun <lin.sun@zoom.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
    Enable auto-merge for meld to follow the vimdiff beharior
    
    Hi, the mergetool "meld" does NOT merge the no-conflict changes, while
    the mergetool "vimdiff" will merge the no-conflict changes and highlight
    the conflict parts. This patch will make the mergetool "meld" similar to
    "vimdiff", auto-merge the no-conflict changes, highlight conflict parts.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-781%2Fsunlin7%2Fmaster-v11
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-781/sunlin7/master-v11
Pull-Request: https://github.com/git/git/pull/781

Range-diff vs v10:

 1:  a4f1b8c2fa ! 1:  8015c4c98e Support auto-merge for meld to follow the vim-diff behavior
     @@ mergetools/meld: diff_cmd () {
      -		meld_has_output_option=true
      -	else
      -		meld_has_output_option=false
     -+		meld_use_auto_merge_option=$(git config mergetool.meld.useAutoMerge)
     -+		case "$meld_use_auto_merge_option" in
     -+		"")
     -+			meld_use_auto_merge_option=false
     -+			;;
     -+		[Tt]ure|TRUE)
     -+			meld_use_auto_merge_option=true
     -+			;;
     -+		[Ff]alse|FALSE)
     -+			meld_use_auto_merge_option=false
     -+			;;
     -+		[Aa]uto|AUTO)
     -+			# testing the "--auto-merge" option only if config is "auto"
     -+			init_meld_help_msg
     -+
     -+			case "$meld_help_msg" in
     -+			*"--auto-merge"*)
     -+				meld_use_auto_merge_option=true
     -+				;;
     -+			*)
     -+				meld_use_auto_merge_option=false
     -+				;;
     -+			esac
     -+			;;
     -+		*)
     -+			# try detect boolean for 'on'||'yes'||numberic value
     -+			bool_value=$(git config --bool mergetool.meld.useAutoMerge 2>/dev/null)
     -+			if test -n "$bool_value"
     ++		if meld_use_auto_merge_option=$( \
     ++			git config --bool mergetool.meld.useAutoMerge 2>/dev/null)
     ++		then
     ++			: use configured value
     ++		else
     ++			meld_use_auto_merge_option=$(git config mergetool.meld.useAutoMerge)
     ++			if test "$meld_use_auto_merge_option" = "auto"
      +			then
     -+				meld_use_auto_merge_option="$bool_value"
     ++				# testing the "--auto-merge" option only if config is "auto"
     ++				init_meld_help_msg
     ++
     ++				case "$meld_help_msg" in
     ++				*"--auto-merge"* | *'[OPTION...]'*)
     ++					meld_use_auto_merge_option=true
     ++					;;
     ++				*)
     ++					meld_use_auto_merge_option=false
     ++					;;
     ++				esac
      +			else
      +				meld_use_auto_merge_option=false
      +			fi
     -+			;;
     -+		esac
     ++		fi
       	fi
       }


 Documentation/config/mergetool.txt | 10 ++++
 mergetools/meld                    | 81 ++++++++++++++++++++++++------
 2 files changed, 75 insertions(+), 16 deletions(-)


base-commit: 07d8ea56f2ecb64b75b92264770c0a664231ce17

Comments

Đoàn Trần Công Danh July 7, 2020, 3:31 p.m. UTC | #1
On 2020-07-07 07:13:43+0000, sunlin via GitGitGadget <gitgitgadget@gmail.com> wrote:
> -# Check whether we should use 'meld --output <file>'
> -check_meld_for_output_version () {
> -	meld_path="$(git config mergetool.meld.path)"
> -	meld_path="${meld_path:-meld}"
> +# Get meld help message
> +init_meld_help_msg () {
> +	if test -z "$meld_help_msg"
> +	then
> +		meld_path="$(git config mergetool.meld.path || echo meld)"
> +		meld_help_msg=$($meld_path --help 2>&1)

I haven't thought about this until now.
`$meld_path` should be quoted.

	meld_help_msg="$("$meld_path" --help 2>&1)"

Either that or our Windows friends will complain soon:

	C:/Program Files/Meld/meld --help

(I don't know where meld will be installed by default in Window exactly,
above command is just a guess)

> +	fi
> +}
>  
> -	if meld_has_output_option=$(git config --bool mergetool.meld.hasOutput)
> +# Check the features and set flags
> +check_meld_for_features () {
> +	# Check whether we should use 'meld --output <file>'
> +	if test -z "$meld_has_output_option"
>  	then
> -		: use configured value
> -	elif "$meld_path" --help 2>&1 |
> -		grep -e '--output=' -e '\[OPTION\.\.\.\]' >/dev/null
> +		meld_has_output_option=$(git config --bool mergetool.meld.hasOutput)
> +		case "$meld_has_output_option" in
> +		true|false)
> +			: use configured value
> +			;;
> +		*)
> +			: empty or invalid configured value, detecting "--output" automatically
> +			init_meld_help_msg
> +
> +			case "$meld_help_msg" in
> +			*"--output="* | *'[OPTION...]'*)
> +				# All version that has [OPTION...] supports --output

Good comments :)

> +				meld_has_output_option=true
> +				;;
> +			*)
> +				meld_has_output_option=false
> +				;;
> +			esac
> +			;;
> +		esac
> +	fi
> +	# Check whether we should use 'meld --auto-merge ...'
> +	if test -z "$meld_use_auto_merge_option"
>  	then
> -		: old ones mention --output and new ones just say OPTION...
> -		meld_has_output_option=true
> -	else
> -		meld_has_output_option=false
> +		if meld_use_auto_merge_option=$( \
> +			git config --bool mergetool.meld.useAutoMerge 2>/dev/null)
> +		then
> +			: use configured value
> +		else
> +			meld_use_auto_merge_option=$(git config mergetool.meld.useAutoMerge)
> +			if test "$meld_use_auto_merge_option" = "auto"
> +			then
> +				# testing the "--auto-merge" option only if config is "auto"
> +				init_meld_help_msg
> +
> +				case "$meld_help_msg" in
> +				*"--auto-merge"* | *'[OPTION...]'*)
> +					meld_use_auto_merge_option=true
> +					;;
> +				*)
> +					meld_use_auto_merge_option=false
> +					;;
> +				esac
> +			else
> +				meld_use_auto_merge_option=false

If I read other emails correctly (which I usually don't),
I think we would want to bail out in this case.

> +			fi
> +		fi
>  	fi
>  }
> 
> base-commit: 07d8ea56f2ecb64b75b92264770c0a664231ce17
> -- 
> gitgitgadget
Lin Sun July 8, 2020, 12:57 a.m. UTC | #2
Hi Doah,

>`$meld_path` should be quoted.
>...
Yes, you're totally right, I'll fix the `$meld_path` and more changes will upload with the [PATCH v12].
I'll update to you when the patch is ready. 

Regards
Lin
diff mbox series

Patch

diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt
index 09ed31dbfa..16a27443a3 100644
--- a/Documentation/config/mergetool.txt
+++ b/Documentation/config/mergetool.txt
@@ -30,6 +30,16 @@  mergetool.meld.hasOutput::
 	to `true` tells Git to unconditionally use the `--output` option,
 	and `false` avoids using `--output`.
 
+mergetool.meld.useAutoMerge::
+	When the `--auto-merge` is given, meld will merge all non-conflicting
+	parts automatically, highlight the conflicting parts and wait for
+	user decision.  Setting `mergetool.meld.useAutoMerge` to `true` tells
+	Git to unconditionally use the `--auto-merge` option with `meld`.
+	Setting this value to `auto` makes git detect whether `--auto-merge`
+	is supported and will only use `--auto-merge` when available.  A
+	value of `false` avoids using `--auto-merge` altogether, and is the
+	default value.
+
 mergetool.keepBackup::
 	After performing a merge, the original file with conflict markers
 	can be saved as a file with a `.orig` extension.  If this variable
diff --git a/mergetools/meld b/mergetools/meld
index 7a08470f88..3463aee87e 100644
--- a/mergetools/meld
+++ b/mergetools/meld
@@ -3,34 +3,83 @@  diff_cmd () {
 }
 
 merge_cmd () {
-	if test -z "${meld_has_output_option:+set}"
+	check_meld_for_features
+
+	option_auto_merge=
+	if test "$meld_use_auto_merge_option" = true
 	then
-		check_meld_for_output_version
+		option_auto_merge="--auto-merge"
 	fi
 
 	if test "$meld_has_output_option" = true
 	then
-		"$merge_tool_path" --output="$MERGED" \
+		"$merge_tool_path" $option_auto_merge --output="$MERGED" \
 			"$LOCAL" "$BASE" "$REMOTE"
 	else
-		"$merge_tool_path" "$LOCAL" "$MERGED" "$REMOTE"
+		"$merge_tool_path" $option_auto_merge "$LOCAL" "$MERGED" "$REMOTE"
 	fi
 }
 
-# Check whether we should use 'meld --output <file>'
-check_meld_for_output_version () {
-	meld_path="$(git config mergetool.meld.path)"
-	meld_path="${meld_path:-meld}"
+# Get meld help message
+init_meld_help_msg () {
+	if test -z "$meld_help_msg"
+	then
+		meld_path="$(git config mergetool.meld.path || echo meld)"
+		meld_help_msg=$($meld_path --help 2>&1)
+	fi
+}
 
-	if meld_has_output_option=$(git config --bool mergetool.meld.hasOutput)
+# Check the features and set flags
+check_meld_for_features () {
+	# Check whether we should use 'meld --output <file>'
+	if test -z "$meld_has_output_option"
 	then
-		: use configured value
-	elif "$meld_path" --help 2>&1 |
-		grep -e '--output=' -e '\[OPTION\.\.\.\]' >/dev/null
+		meld_has_output_option=$(git config --bool mergetool.meld.hasOutput)
+		case "$meld_has_output_option" in
+		true|false)
+			: use configured value
+			;;
+		*)
+			: empty or invalid configured value, detecting "--output" automatically
+			init_meld_help_msg
+
+			case "$meld_help_msg" in
+			*"--output="* | *'[OPTION...]'*)
+				# All version that has [OPTION...] supports --output
+				meld_has_output_option=true
+				;;
+			*)
+				meld_has_output_option=false
+				;;
+			esac
+			;;
+		esac
+	fi
+	# Check whether we should use 'meld --auto-merge ...'
+	if test -z "$meld_use_auto_merge_option"
 	then
-		: old ones mention --output and new ones just say OPTION...
-		meld_has_output_option=true
-	else
-		meld_has_output_option=false
+		if meld_use_auto_merge_option=$( \
+			git config --bool mergetool.meld.useAutoMerge 2>/dev/null)
+		then
+			: use configured value
+		else
+			meld_use_auto_merge_option=$(git config mergetool.meld.useAutoMerge)
+			if test "$meld_use_auto_merge_option" = "auto"
+			then
+				# testing the "--auto-merge" option only if config is "auto"
+				init_meld_help_msg
+
+				case "$meld_help_msg" in
+				*"--auto-merge"* | *'[OPTION...]'*)
+					meld_use_auto_merge_option=true
+					;;
+				*)
+					meld_use_auto_merge_option=false
+					;;
+				esac
+			else
+				meld_use_auto_merge_option=false
+			fi
+		fi
 	fi
 }