Skip to contentSkip to conversation

vimdiff: new implementation with layout support

PATCH Superseded Fernando Ramos 3 participants 9 messages Nov 30, 2021 – Dec 4, 2021 Documentation

v3 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

v3 cover vimdiff: new implementation with layout support

A few weeks ago I presented this RFC [1] where I introduced a new variant of the vimdiff merge tool ("vimdiff4") that creates three tabs (instead of just one) that look like this:

------------------------------------------
| <TAB #1> | TAB #2 | TAB #3 | |
------------------------------------------
| | | |
| LOCAL | BASE | REMOTE |
| | | | <---- Same information
------------------------------------------ presented by the
| | "standard" vimdiff
| MERGED | merge tool
| |
------------------------------------------

------------------------------------------
| TAB #1 | <TAB #2> | TAB #3 | |
------------------------------------------
| | |
| | |
| | |
| BASE | LOCAL | <---- Only differences
| | | between BASE and
| | | LOCAL are shown
| | |
------------------------------------------

------------------------------------------
| TAB #1 | TAB #2 | <TAB #3> | |
------------------------------------------
| | |
| | |
| | |
| BASE | REMOTE | <---- Only differences
| | | between BASE and
| | | REMOTE are shown
| | |
------------------------------------------

The motivation behind this was that, for non-trivial merges, the three way diff presented in the first tab tends to be very confusing and in these cases indivial diffs between BASE and LOCAL and between BASE and REMOTE are very useful.

I have been using a "custom" merge tool for months to achieve this same result by adding these lines to my .gitconfig file:

[mergetool "supermerge"]
cmd = vim -f -d -c \"4wincmd w | wincmd J | tabnew | edit $LOCAL | vertical diffsplit $BASE | tabnew | edit $REMOTE | vertical diffsplit $BASE | 2tabprevious\" \"$LOCAL\" \"$BASE\" \"$REMOTE\" \"$MERGED\" trustExitCode = true

...and, because I found this "trick" very useful, I thought it would be a good idea to add it as a git built-in merge tool (called "vimdiff4" because 1, 2 and 3 had already been taken) for everyone to use... and that's exactly what the RFC I published did.

Now... as you can see in the RFC thread [1], David and Juno suggested that maybe, instead of creating *yet another vimdiff variant*, we should take this opportunity to:

* Come up with a more general way of defining arbitrary vim layouts.

* Re-implement "vimdiff1", "vimdiff2" and "vimdiff3" using this new mechanism (after all, the only difference among them is that they present different layouts to the user)

* Add documentation to all of this.

And the result of that work is what I'm presenting today :)

Some things I would like to mention:

1. There are three commits in this patch series:

- The first one implements the logic to generate new arbitrary layouts and also re-defines "vimdiff1", "vimdiff2" and "vimdiff3" on top of it.

- The second one adds documentation. It is probably a good idea to start reviewing this commit before the first one!

- The last commit *is not meant to be merged now*. It removes "vimdiff1", "vimdiff2" and "vimdiff3", which is something that should only be done after one or two releases with a deprecation notice and only if everyone agrees to do so :)

2. "mergetools/vimdiff" is now a ~800 lines bash script, but most of it is documentation (which is embedded in the tool itself for easier maintenance) and unit tests.
I have only tested it with bash, but I've tried not to use any command not already being used somewhere else, so I expect it to work in the same places it was working before (however, let me know if there are some shell compatibility requirements and I'll try to check them).

3. Regarding unit tests, "mergetool/vimdiff" contains instructions on how to run them (just call the script without arguments after making changes, to make sure you didn't break anything).
Right now it prints "OK" on all test cases (obviously) [2]

3. The "git {diff,merge}tool --tool-help" command now also prints the documentation for each tool (instead of just its name, as before). You can see an example of the output here ([3] and [4])

Finally, let me say that, while I like what this patch series achieves, I would also *completely* understand if you decide not to merge it due to being a complex solution to a simple problem that can be solved (as I had been doing up until today) by just adding three line to one's .gitconfig.

[mergetool "supermerge"]
cmd = vim -f -d -c ...(custom complex sequence of vim commands)... trustExitCode = true

Let me know what you think.

Thanks.

References:

[1] https://lore.kernel.org/git/[email protected]/#r
[2] https://pastebin.com/kuQ5pETG
[3] https://pastebin.com/yvLWxeiM
[4] https://pastebin.com/qNc7qymp

New in v2:

* Remove deprecation of vimdiff{1,2,3} (they will remain for backwards compatibility, but built on top of the new generic layout mechanism)

* Remove unnecessary "IFS="

* Replace DEBUG --> GIT_MERGETOOL_VIMDIFF_DEBUG

* Stop using "local" (turns out it was not necessary)

* Stop using bash arrays (use arrays of variables instead)

* Stop using bash substring expansion (use a new "substring" function instead).

* Refactor some of the internal loops to make the code faster. This was needed because the two previous changes (specially the one where I stop using "substring expansion") slowed down the script to a point where I had to wait for a few *seconds* before the "layout" string was resolved (recursion + bash forks are a recipe for sluggishness). Fortunately we are back to the low hundreds of milliseconds range.

* Change markers:
- File to save: * --> @
- New tab : ; --> +
- Vert split : | --> ,
- Horz split : - --> /

* Rewrite examples to use as few parenthesis as possible (typically zero) and better explain operators priority.

* Other fixes to remove problems reported by "shellcheck --shell=sh" (which checks syntax agains the POSIX shell spec)

* Rename "index_..." vars to make more obvious what they do.

* Use "$" inside arithmetic expressions $((...))
NOTE: "shellcheck" issues a warning stating that "$" is not needed inside arithmetic expressions.

* Use "test -n" instead of "! test -z"

* Use "=" instead of "==" in "test"

* Use "= 0" instead of "-eq 0"

* Do not use "eval" nor "--" when copying a file to MERGED

* Do not use "-o" with grep

* Use <<-\EOF instead of <<\ENDOFMESSAGE and remove extra indent in "here

    docs".

* Also, let me put here some answers to questions made in the replies to version v1 of this patch set:

> What do backticks do in here?
>
> some_var=(
> # Name "Rick Deckard"
> # Age "Unknown"
> # Occupation "Blade runner"
> )

The backticks execute the code inside, which is a comment (everything after a "#" is considered a comment by the shell), thus it does nothing.

The # ... trick can be used to insert inline comments in bash. Another example:

$ ls -l # long format -h # human readable *.txt

In any case, as you can see in this new revision, because I'm no longer using bash arrays, this trick to comment each test case is not needed anymore.

> Why is "eval" needed here:
>
> eval "$merge_tool_path" \
> -f "$FINAL_CMD" "$LOCAL" "$BASE" "$REMOTE" "$MERGED"

Variable "$FINAL_CMD" contains a string that looks like this:

$ echo $FINAL_CMD
-c "vim cmd 1 | vim cmd 2 | ..." -c "tabfirst"

We need to call "vim" exactly like that, but if we do this...

$ vim $FINAL_CMD

...then "vim" will be excev'ed with the following arguments:

1. -c
2. "vim
3. cmd
4. 1
...

...instead of the desired scenario:

1. -c
2. cmd 1 | cmd 2 | ...
3. -c
4. tabfirst

Using "eval" fixes this. A shorter example shows how this works:

$ A="1 \"2 3\""

$ ls $A
ls: cannot access '1': No such file or directory
ls: cannot access '"2': No such file or directory
ls: cannot access '3"': No such file or directory

$ eval ls $A
ls: cannot access '1': No such file or directory
ls: cannot access '2 3': No such file or directory

* Finally, I think I have addressed all comments to v1 *except for two things*:

1. Moving the documentation to "Documentation/" instead of having it embedded inside the "mergetools/vimdiff" script.

2. Move unit tests to the "test suit"

For (1) I would like more details. Is the idea not to print any documentation when running "git mergetool --tool-help" and have all the details included in "git help mergetool" instead?
Right now "git help mergetool" does not mention any tool specific details and, instead, redirects the user to "git mergetool --tool-help" (that's why I originally placed the new documentation there).
In any case, all the doc has been placed on its own commit, so once we decide how to proceed its just a matter of reverting it.

For (2) I still need to investigate how this is done and prepare a "v3" if needed :)

New in v3:

* Rebase on top of latest master

* Documentation moved to "Documentation/". Running "git mergetool --tool-help" now works like before (ie. it just lists all available merge tools) except that a one line reference to a "man" entry is also printed for those entries providing one (right now, only vimdiff):

$ git mergetool --tool-help
'git mergetool --tool=<tool>' may be set to one of the following:
araxis
meld
vimdiff
Run 'man git-mergetool--vimdiff' for details
vimdiff1
Run 'man git-mergetool--vimdiff' for details
...

* New test file "t/7609-mergetool--lib.sh" created. Right now it only contains one test which calls "mergetools/vimdiff" with a special environment set, causing layout unit tests to run.

Fernando Ramos (3):
vimdiff: new implementation with layout support
vimdiff: add tool documentation
vimdiff: integrate layout tests in the unit tests framework ('t'
folder)

 Documentation/git-difftool--vimdiff.txt  |  41 ++
 Documentation/git-mergetool--vimdiff.txt | 195 ++++++++
 git-mergetool--lib.sh                    |  14 +
 mergetools/vimdiff                       | 577 ++++++++++++++++++++++-
 t/t7609-mergetool--lib.sh                |  17 +
 5 files changed, 819 insertions(+), 25 deletions(-)
 create mode 100644 Documentation/git-difftool--vimdiff.txt
 create mode 100644 Documentation/git-mergetool--vimdiff.txt
 create mode 100755 t/t7609-mergetool--lib.sh

base-commit: 35151cf0720460a897cde9b8039af364743240e7

Signature · 1 line
2.34.0
#1 lore raw

PATCH v3 1/3 vimdiff: new implementation with layout support

When running 'git mergetool -t vimdiff', a new configuration option ('mergetool.vimdiff.layout') can now be used to select how the user wants the different windows, tabs and buffers to be displayed.

If the option is not provided, the layout will be the same one that was being used before this commit (ie. two rows with LOCAL, BASE and COMMIT in the top one and MERGED in the bottom one).

The 'vimdiff' variants ('vimdiff{1,2,3}') still work but, because they represented nothing else than different layouts, are now internally implemented as a subcase of 'vimdiff' with the corresponding pre-configured 'layout'.

---
 mergetools/vimdiff | 559 ++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 532 insertions(+), 27 deletions(-)
mergetools/vimdiff +532 -27
index 96f6209a04..ed0d8584f7 100644
@@ -1,48 +1,538 @@
+#!/bin/bash
+
+# This script can be run in two different contexts:
+#
+#   - From git, when the user invokes the "vimdiff" merge tool. In this context
+#     this script expects the following environment variables (among others) to
+#     be defined (which is something "git" takes care of):
+#
+#       - $BASE
+#       - $LOCAL
+#       - $REMOTE
+#       - $MERGED
+#
+#     In this mode, all this script does is to run the next command:
+#
+#         vim -f -c ... $LOCAL $BASE $REMOTE $MERGED
+#
+#     ...where the "..." string depends on the value of the
+#     "mergetool.vimdiff.layout" configuration variable and is used to open vim
+#     with a certain layout of buffers, windows and tabs.
+#
+#   - From the shell, manually. This is only expected to be done by developers
+#     who are editing this script. When this happens, the script runs a battery
+#     of unit tests to make sure nothing breaks.
+#     In this context this script does not expect any particular environment
+#     variable to be set.
+#
+
+
+
+################################################################################
+## Internal functions (not meant to be used outside this script)
+################################################################################
+
+debug_print() { 
+	# Send message to stderr if global variable DEBUG is set to "true"
+
+	if test -n "$GIT_MERGETOOL_VIMDIFF_DEBUG"
+	then
+		>&2 echo "$@"
+	fi
+}
+
+substring() {
+	# Return a substring of $1 containing $3 characters starting at
+	# zero-based offset $2.
+	# 
+	# Examples:
+	#
+	#   substring "Hello world" 0 4  --> "Hell"
+	#   substring "Hello world" 3 4  --> "lo w"
+	#   substring "Hello world" 3 10 --> "lo world"
+
+	STRING=$1
+	START=$2
+	LEN=$3
+
+	echo "$STRING" | cut -c$(( $START + 1 ))-$(( $START + $LEN))
+}
+
+gen_cmd_aux() {
+	# Auxiliary function used from "gen_cmd()".
+	# Read that other function documentation for more details.
+
+	LAYOUT=$1 
+	CMD=$2  # This is a second (hidden) argument used for recursion  
+
+	debug_print
+	debug_print "LAYOUT    : $LAYOUT"
+	debug_print "CMD       : $CMD"
+
+	if test -z "$CMD"
+	then
+		CMD="echo" # vim "nop" operator
+	fi
+
+	start=0
+	end=${#LAYOUT}
+
+	nested=0
+	nested_min=100
+
+
+	# Step 1:
+	#
+	# Increase/decrease "start"/"end" indices respectively to get rid of
+	# outer parenthesis.
+	#
+	# Example:
+	#
+	#   - BEFORE: (( LOCAL , BASE ) / MERGED )
+	#   - AFTER :  ( LOCAL , BASE ) / MERGED 
+
+	oldIFS=$IFS
+	IFS=#
+	for c in $(echo "$LAYOUT" | sed 's:.:&#:g')
+	do
+		if test "$c" = " "
+		then
+			continue
+		fi
+
+		if test "$c" = "("
+		then
+			nested=$(( $nested + 1 ))
+			continue
+		fi
+
+		if test "$c" = ")"
+		then
+			nested=$(( $nested - 1 ))
+			continue
+		fi
+
+		if test "$nested" -lt "$nested_min"
+		then
+			nested_min=$nested
+		fi
+	done
+	IFS=$oldIFS
+
+	debug_print "NESTED MIN: $nested_min"
+
+	while test "$nested_min" -gt "0"
+	do
+		start=$(( $start + 1 ))
+		end=$(( $end - 1 ))
+
+		start_minus_one=$(( $start - 1 ))
+
+		while ! test "$(substring "$LAYOUT" "$start_minus_one" 1)" = "("
+		do
+			start=$(( $start + 1 ))
+			start_minus_one=$(( $start_minus_one + 1 ))
+		done
+
+		while ! test "$(substring "$LAYOUT" "$end" 1)" = ")"
+		do
+			end=$(( $end - 1 ))
+		done
+
+		nested_min=$(( $nested_min - 1 ))
+	done
+
+	debug_print "CLEAN     : $(substring "$LAYOUT" "$start" "$(( $end - $start ))")"
+
+
+	# Step 2:
+	#
+	# Search for all valid separators ("+", "/" or ",") which are *not*
+	# inside parenthesis. Save the index at which each of them makes the
+	# first appearance.
+
+	index_new_tab=""
+	index_horizontal_split=""
+	index_vertical_split=""
+
+	nested=0
+	i=$(( $start - 1 ))
+
+	oldIFS=$IFS
+	IFS=#
+	for c in $(substring "$LAYOUT" "$start" "$(( $end - $start ))" | sed 's:.:&#:g');
+	do
+		i=$(( $i + 1 ))
+
+		if test "$c" = " "
+		then
+			continue
+		fi
+
+		if test "$c" = "("
+		then
+			nested=$(( $nested + 1 ))
+			continue
+		fi
+
+		if test "$c" = ")"
+		then
+			nested=$(( $nested - 1 ))
+			continue
+		fi
+
+		if test "$nested" = 0
+		then
+			current=$c
+			
+			if test "$current" = "+"
+			then
+				if test -z "$index_new_tab"
+				then
+					index_new_tab=$i
+				fi
+
+			elif test "$current" = "/"
+			then
+				if test -z "$index_horizontal_split"
+				then
+					index_horizontal_split=$i
+				fi
+
+			elif test "$current" = ","
+			then
+				if test -z "$index_vertical_split"
+				then
+					index_vertical_split=$i
+				fi
+			fi
+		fi
+	done
+	IFS=$oldIFS
+
+
+	# Step 3:
+	#
+	# Process the separator with the highest order of precedence
+	# (";" has the highest precedence and "|" the lowest one).
+	#
+	# By "process" I mean recursively call this function twice: the first
+	# one with the substring at the left of the separator and the second one
+	# with the one at its right.
+
+	terminate="false"
+
+	if ! test -z "$index_new_tab"
+	then
+		before="-tabnew"
+		after="tabnext"
+		index=$index_new_tab
+		terminate="true"
+
+	elif ! test -z "$index_horizontal_split"
+	then
+		before="split"
+		after="wincmd j"
+		index=$index_horizontal_split
+		terminate="true"
+
+	elif ! test -z "$index_vertical_split"
+	then
+		before="vertical split"
+		after="wincmd l"
+		index=$index_vertical_split
+		terminate="true"
+	fi
+
+	if  test "$terminate" = "true"
+	then
+		CMD="$CMD | $before"
+		CMD=$(gen_cmd_aux "$(substring "$LAYOUT" "$start" "$(( $index - $start ))")" "$CMD")
+		CMD="$CMD | $after"
+		CMD=$(gen_cmd_aux "$(substring "$LAYOUT" "$(( $index + 1 ))" "$(( ${#LAYOUT} - $index ))")" "$CMD")
+		echo "$CMD"
+		return
+	fi
+
+
+	# Step 4:
+	#
+	# If we reach this point, it means there are no separators and we just
+	# need to print the command to display the specified buffer
+
+	target=$(substring "$LAYOUT" "$start" "$(( $end - $start ))" | sed 's:[ @();|-]::g')
+
+	if test "$target" = "LOCAL"
+	then
+		CMD="$CMD | 1b"
+
+	elif test "$target" = "BASE"
+	then
+		CMD="$CMD | 2b"
+
+	elif test "$target" = "REMOTE"
+	then
+		CMD="$CMD | 3b"
+
+	elif test "$target" = "MERGED"
+	then
+		CMD="$CMD | 4b"
+
+	else
+		CMD="$CMD | ERROR: >$target<"
+	fi
+
+	echo "$CMD"
+	return
+}
+
+
+gen_cmd() {
+	# This function returns (in global variable FINAL_CMD) the string that
+	# you can use when invoking "vim" (as shown next) to obtain a given
+	# layout:
+	#
+	#   $ vim -f $FINAL_CMD "$LOCAL" "$BASE" "$REMOTE" "$MERGED"
+	#
+	# It takes one single argument: a string containing the desired layout
+	# definition.
+	#
+	# The syntax of the "layout definitions" is explained in ... (TODO)...
+	# but you can already intuitively understand how it works by knowing
+	# that...
+	#
+	#   * ";" means "a new vim tab"
+	#   * "-" means "a new vim horizontal split"
+	#   * "|" means "a new vim vertical split"
+	#
+	# It also returns (in global variable FINAL_TARGET) the name ("LOCAL",
+	# "BASE", "REMOTE" or "MERGED") of the file that is marked with an "@",
+	# or "MERGED" if none of them is.
+	#
+	# Example:
+	#
+	#     gen_cmd "@LOCAL , REMOTE"
+	#     |
+	#     `-> FINAL_CMD    == "-c \"echo | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	#         FINAL_TARGET == "LOCAL"
+
+	LAYOUT=$1 
+
+
+	# Search for a "@" in one of the files identifiers ("LOCAL", "BASE",
+	# "REMOTE", "MERGED"). If not found, use "MERGE" as the default file
+	# where changes will be saved.
+
+	if echo "$LAYOUT" | grep @LOCAL >/dev/null
+	then
+		FINAL_TARGET="LOCAL"
+	elif echo "$LAYOUT" | grep @BASE >/dev/null
+	then
+		FINAL_TARGET="BASE"
+	else
+		FINAL_TARGET="MERGED"
+	fi
+
+
+	# Obtain the first part of vim "-c" option to obtain the desired layout
+
+	CMD=$(gen_cmd_aux "$LAYOUT")
+
+
+	# Adjust the just obtained script depending on whether more than one
+	# windows are visible or not
+
+	if echo "$LAYOUT" | grep ",\|/" >/dev/null
+	then
+		CMD="$CMD | tabdo windo diffthis"
+	else
+		CMD="$CMD | bufdo diffthis"
+	fi
+
+
+	# Add an extra "-c" option to move to the first tab (notice that we
+	# can't simply append the command to the previous "-c" string as
+	# explained here: https://github.com/vim/vim/issues/9076
+
+	FINAL_CMD="-c \"$CMD\" -c \"tabfirst\""
+}
+
+
+run_unit_tests() {
+	# Function to make sure that we don't break anything when modifying this
+	# script.
+	#
+	# This function is automatically executed when you execute this directly
+	# from the shell
+
+	NUMBER_OF_TEST_CASES=16
+
+	TEST_CASE_01="LOCAL,MERGED,REMOTE"
+	TEST_CASE_02="LOCAL/MERGED/REMOTE"
+	TEST_CASE_03="(LOCAL/REMOTE),MERGED"
+	TEST_CASE_04="MERGED,(LOCAL/REMOTE)"
+	TEST_CASE_05="(LOCAL,REMOTE)/MERGED"
+	TEST_CASE_06="MERGED/(LOCAL,REMOTE)"
+	TEST_CASE_07="(LOCAL,BASE,REMOTE)/MERGED"
+	TEST_CASE_08="(LOCAL/BASE/REMOTE),MERGED"
+	TEST_CASE_09="@LOCAL,REMOTE"
+	TEST_CASE_10="MERGED"
+	TEST_CASE_11="(LOCAL,BASE,REMOTE)/MERGED+BASE,LOCAL+BASE,REMOTE+(LOCAL/BASE/REMOTE),MERGED"
+	TEST_CASE_12="((LOCAL,REMOTE)/BASE),MERGED"
+	TEST_CASE_13="((LOCAL,REMOTE)/BASE),((LOCAL/REMOTE),MERGED)"
+	TEST_CASE_14="BASE,REMOTE+BASE,LOCAL"
+	TEST_CASE_15="  ((  (LOCAL , BASE , REMOTE) / MERGED))   +(BASE)   , LOCAL+ BASE , REMOTE+ (((LOCAL / BASE / REMOTE)) ,    MERGED   )  "
+	TEST_CASE_16="LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL / BASE / REMOTE),MERGED"
+
+	EXPECTED_CMD_01="-c \"echo | vertical split | 1b | wincmd l | vertical split | 4b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_02="-c \"echo | split | 1b | wincmd j | split | 4b | wincmd j | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_03="-c \"echo | vertical split | split | 1b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_04="-c \"echo | vertical split | 4b | wincmd l | split | 1b | wincmd j | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_05="-c \"echo | split | vertical split | 1b | wincmd l | 3b | wincmd j | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_06="-c \"echo | split | 4b | wincmd j | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_07="-c \"echo | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_08="-c \"echo | vertical split | split | 1b | wincmd j | split | 2b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_09="-c \"echo | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_10="-c \"echo | 4b | bufdo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_11="-c \"echo | -tabnew | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabnext | -tabnew | vertical split | 2b | wincmd l | 1b | tabnext | -tabnew | vertical split | 2b | wincmd l | 3b | tabnext | vertical split | split | 1b | wincmd j | split | 2b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_12="-c \"echo | vertical split | split | vertical split | 1b | wincmd l | 3b | wincmd j | 2b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_13="-c \"echo | vertical split | split | vertical split | 1b | wincmd l | 3b | wincmd j | 2b | wincmd l | vertical split | split | 1b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_14="-c \"echo | -tabnew | vertical split | 2b | wincmd l | 3b | tabnext | vertical split | 2b | wincmd l | 1b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_15="-c \"echo | -tabnew | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabnext | -tabnew | vertical split | 2b | wincmd l | 1b | tabnext | -tabnew | vertical split | 2b | wincmd l | 3b | tabnext | vertical split | split | 1b | wincmd j | split | 2b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+	EXPECTED_CMD_16="-c \"echo | -tabnew | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabnext | -tabnew | vertical split | 2b | wincmd l | 1b | tabnext | -tabnew | vertical split | 2b | wincmd l | 3b | tabnext | vertical split | split | 1b | wincmd j | split | 2b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\""
+
+	EXPECTED_TARGET_01="MERGED"
+	EXPECTED_TARGET_02="MERGED"
+	EXPECTED_TARGET_03="MERGED"
+	EXPECTED_TARGET_04="MERGED"
+	EXPECTED_TARGET_05="MERGED"
+	EXPECTED_TARGET_06="MERGED"
+	EXPECTED_TARGET_07="MERGED"
+	EXPECTED_TARGET_08="MERGED"
+	EXPECTED_TARGET_09="LOCAL"
+	EXPECTED_TARGET_10="MERGED"
+	EXPECTED_TARGET_11="MERGED"
+	EXPECTED_TARGET_12="MERGED"
+	EXPECTED_TARGET_13="MERGED"
+	EXPECTED_TARGET_14="MERGED"
+	EXPECTED_TARGET_15="MERGED"
+	EXPECTED_TARGET_16="MERGED"
+
+	at_least_one_ko="false"
+
+	for i in $(seq -w 1 99)
+	do
+		if test "$i" -gt $NUMBER_OF_TEST_CASES
+		then
+			break
+		fi
+
+		gen_cmd "$(eval echo \${TEST_CASE_"$i"})"
+
+		if test "$FINAL_CMD" = "$(eval echo \${EXPECTED_CMD_"$i"})" \
+			&& test "$FINAL_TARGET" = "$(eval echo \${EXPECTED_TARGET_"$i"})"
+		then
+			printf "Test Case #%02d: OK\n" "$(echo "$i" | sed 's/^0*//')"
+		else
+			printf "Test Case #%02d: KO !!!!\n" "$(echo "$i" | sed 's/^0*//')"
+			echo "  FINAL_CMD              : $FINAL_CMD"
+			echo "  FINAL_CMD (expected)   : $(eval echo \${EXPECTED_CMD_"$i"})"
+			echo "  FINAL_TARGET           : $FINAL_TARGET"
+			echo "  FINAL_TARGET (expected): $(eval echo \${EXPECTED_TARGET_"$i"})"
+			at_least_one_ko="true"
+		fi
+	done
+	
+	if test "$at_least_one_ko" = "true"
+	then
+		return 255
+	else
+		return 0
+	fi
+}
+
+
+################################################################################
+## API functions (called from "git-mergetool--lib.sh")
+################################################################################
+
 diff_cmd () {
 	"$merge_tool_path" -R -f -d \
 		-c 'wincmd l' -c 'cd $GIT_PREFIX' "$LOCAL" "$REMOTE"
 }
 
+
 merge_cmd () {
+	layout=$(git config mergetool.$merge_tool.layout)
+
 	case "$1" in
 	*vimdiff)
-		if $base_present
+		if test -z "$layout"
 		then
-			"$merge_tool_path" -f -d -c '4wincmd w | wincmd J' \
-				"$LOCAL" "$BASE" "$REMOTE" "$MERGED"
-		else
-			"$merge_tool_path" -f -d -c 'wincmd l' \
-				"$LOCAL" "$MERGED" "$REMOTE"
+			# Default layout when none is specified
+			layout="(LOCAL,BASE,REMOTE)/MERGED"
 		fi
 		;;
 	*vimdiff1)
-		"$merge_tool_path" -f -d \
-			-c 'echon "Resolve conflicts leftward then save. Use :cq to abort."' \
-			"$LOCAL" "$REMOTE"
-		ret="$?"
-		if test "$ret" -eq 0
-		then
-			cp -- "$LOCAL" "$MERGED"
-		fi
-		return "$ret"
+		layout="@LOCAL,MERGED"
 		;;
 	*vimdiff2)
-		"$merge_tool_path" -f -d -c 'wincmd l' \
-			"$LOCAL" "$MERGED" "$REMOTE"
+		layout="LOCAL,MERGED,REMOTE"
 		;;
 	*vimdiff3)
-		if $base_present
-		then
-			"$merge_tool_path" -f -d -c 'hid | hid | hid' \
-				"$LOCAL" "$REMOTE" "$BASE" "$MERGED"
-		else
-			"$merge_tool_path" -f -d -c 'hid | hid' \
-				"$LOCAL" "$REMOTE" "$MERGED"
-		fi
+		layout="MERGED"
 		;;
 	esac
+
+	gen_cmd "$layout"
+
+	debug_print ""
+	debug_print "FINAL CMD : $FINAL_CMD"
+	debug_print "FINAL TAR : $FINAL_TARGET"
+
+	if $base_present
+	then
+		eval "$merge_tool_path" \
+			-f "$FINAL_CMD" "$LOCAL" "$BASE" "$REMOTE" "$MERGED"
+	else
+		# If there is no BASE (example: a merge conflict in a new file
+		# with the same name created in both braches which didn't exist
+		# before), close all BASE windows using vim's "quit" command
+
+		FINAL_CMD=$(echo "$FINAL_CMD" | \
+			sed -e 's:2b:quit:g' -e 's:3b:2b:g' -e 's:4b:3b:g')
+
+		eval "$merge_tool_path" \
+			-f "$FINAL_CMD" "$LOCAL" "$REMOTE" "$MERGED"
+	fi
+
+	ret="$?"
+
+	if test "$ret" -eq 0
+	then
+		case "$FINAL_TARGET" in
+		LOCAL)
+			source_path="$LOCAL"
+			;;
+		REMOTE)
+			source_path="$REMOTE"
+			;;
+		MERGED|*)
+			# Do nothing
+			source_path=
+			;;
+		esac
+
+		if test -n "$source_path"
+		then
+			cp "$source_path" "$MERGED"
+		fi
+	fi
+
+	return "$ret"
 }
 
+
 translate_merge_tool_path() {
 	case "$1" in
 	nvimdiff*)
@@ -57,14 +547,29 @@ translate_merge_tool_path() {
 	esac
 }
 
+
 exit_code_trustable () {
 	true
 }
 
+
 list_tool_variants () {
-	for prefix in '' g n; do
-		for suffix in '' 1 2 3; do
+	for prefix in '' g n
+	do
+		for suffix in '' 1 2 3
+		do
 			echo "${prefix}vimdiff${suffix}"
 		done
 	done
 }
+
+
+################################################################################
+## Run unit tests when calling this script with a special env variable set
+################################################################################
+
+if test -n "$GIT_MERGETOOL_VIMDIFF_UNITTESTS"
+then
+	run_unit_tests
+fi
+
Signature · 1 line
2.34.0
#2 lore raw

PATCH v3 2/3 vimdiff: add tool documentation

In reply to Fernando Ramos

Running 'git {merge,diff}tool --tool-help' now also prints usage information about the vimdiff tool (and its variantes) instead of just its name.

Two new functions ('diff_cmd_help()' and 'merge_cmd_help()') have been added to the set of functions that each merge tool (ie. scripts found inside "mergetools/") can overwrite to provided tool specific information.

Right now, only 'mergetools/vimdiff' implements these functions, but other tools are encouraged to do so in the future, specially if they take configuration options not explained anywhere else (as it is the case with the 'vimdiff' tool and the new 'layout' option)

---
 Documentation/git-difftool--vimdiff.txt  |  41 +++++
 Documentation/git-mergetool--vimdiff.txt | 195 +++++++++++++++++++++++
 git-mergetool--lib.sh                    |  14 ++
 mergetools/vimdiff                       |  22 +++
 4 files changed, 272 insertions(+)
 create mode 100644 Documentation/git-difftool--vimdiff.txt
 create mode 100644 Documentation/git-mergetool--vimdiff.txt
Documentation/git-difftool--vimdiff.txt new file +41 -0
new file mode 100644
index 0000000000..b520129ee5
@@ -0,0 +1,41 @@
+git-mergetool{litdd}vimdiff(1)
+==============================
+
+NAME
+----
+git-difftool--vimdiff - Helper script to run vim as a diff tool
+
+SYNOPSIS
+--------
+[verse]
+'git difftool' --tool=vimdiff ... (rest of 'git difftool' options)
+
+DESCRIPTION
+-----------
+When specifying '--tool=vimdiff' in 'git difftool', git will open vim with a
+with two vertical windows: LOCAL changes will be placed in the left window and
+REMOTE changes in the right one.
+
+           ------------------------------------------
+           |                   |                    |
+           |                   |                    |
+           |                   |                    |
+           |     LOCAL         |    REMOTE          |
+           |                   |                    |
+           |                   |                    |
+           |                   |                    |
+           ------------------------------------------
+
+VARIANTS
+--------
+Instead of '--tool=vimdiff', you can also use these other variants:
+
+  * '--tool=gvimdiff', to open gvim instead of vim.
+
+  * '--tool=nvimdiff', to open nvim ('neovim') instead of vim.
+
+GIT
+---
+Part of the linkgit:git[1] suite
+
+
Documentation/git-mergetool--vimdiff.txt new file +195 -0

195 lines not on this page · raw message

git-mergetool--lib.sh +14 -0
index 542a6a75eb..d7420c5d1a 100644
@@ -64,6 +64,12 @@ $(list_tool_variants)"
 				fi
 				shown_any=yes
 				printf "%s%s\n" "$per_line_prefix" "$toolname"
+
+                                (diff_mode && diff_cmd_help "$toolname" || merge_cmd_help "$toolname") |
+				while read -r line
+				do
+					printf "%s\t%s\n" "$per_line_prefix" "$line"
+				done
 			fi
 		done
 
@@ -162,10 +168,18 @@ setup_tool () {
 		return 1
 	}
 
+	diff_cmd_help () {
+		return 0
+	}
+
 	merge_cmd () {
 		return 1
 	}
 
+	merge_cmd_help () {
+		return 0
+	}
+
 	hide_resolved_enabled () {
 		return 0
 	}
mergetools/vimdiff +22 -0
index ed0d8584f7..8614253ef1 100644
@@ -462,6 +462,17 @@ diff_cmd () {
 }
 
 
+diff_cmd_help() {
+	case "$1" in
+	*)
+		echo "Run 'man git-difftool--vimdiff' for details"
+		;;
+	esac
+
+	return 0
+}
+
+
 merge_cmd () {
 	layout=$(git config mergetool.$merge_tool.layout)
 
@@ -533,6 +544,17 @@ merge_cmd () {
 }
 
 
+merge_cmd_help() {
+	case "$1" in
+	*)
+		echo "Run 'man git-mergetool--vimdiff' for details"
+		;;
+	esac
+
+	return 0
+}
+
+
 translate_merge_tool_path() {
 	case "$1" in
 	nvimdiff*)
Signature · 1 line
2.34.0
#3 lore raw

Re: [PATCH v3 2/3] vimdiff: add tool documentation

Quoted 2 lines

+ (diff_mode && diff_cmd_help "$toolname" || merge_cmd_help "$toolname") |

Mis-indenting with spaces v.s. tabs below.

Then this:

Quoted 42 lines
git-mergetool--lib.sh +8 -0
+	diff_cmd_help () {
+		return 0
+	}
+
 	merge_cmd () {
 		return 1
 	}
 
+	merge_cmd_help () {
+		return 0
+	}
+
 	hide_resolved_enabled () {
 		return 0
 	}
mergetools/vimdiff +12 -0
index ed0d8584f7..8614253ef1 100644
@@ -462,6 +462,17 @@ diff_cmd () {
 }
 
 
+diff_cmd_help() {
+	case "$1" in
+	*)
+		echo "Run 'man git-difftool--vimdiff' for details"
+		;;
+	esac
+
+	return 0
+}
+
+
 merge_cmd () {
 	layout=$(git config mergetool.$merge_tool.layout)
 
@@ -533,6 +544,17 @@ merge_cmd () {
 }
 
 
+merge_cmd_help() {

mergetools/vimdiff merge_cmd () { · line 557

Quoted 10 lines
mergetools/vimdiff +10 -0
+	case "$1" in
+	*)
+		echo "Run 'man git-mergetool--vimdiff' for details"
+		;;
+	esac
+
+	return 0
+}
+
+

Isn't the case/esac in those functions entirely redundant and they could just "echo"?

#4 lore raw

Re: [PATCH v3 2/3] vimdiff: add tool documentation

Quoted 15 lines · Ævar Arnfjörð Bjarmason

mergetools/vimdiff merge_cmd () { · line 557

Quoted 12 lines
mergetools/vimdiff +11 -0
+merge_cmd_help() {
+	case "$1" in
+	*)
+		echo "Run 'man git-mergetool--vimdiff' for details"
+		;;
+	esac
+
+	return 0
+}
+
+

Isn't the case/esac in those functions entirely redundant and they could just "echo"?

Yes, I originally left it here in case we wanted to print different messages for different variants (vimdiff, vimdiff2, ...).

But now that the documentation has been placed into a single file, I don't see a reason to keep this. I'll remove it. Thanks for noticing.

#5 lore raw

PATCH v3 3/3 vimdiff: integrate layout tests in the unit tests framework ('t' folder)

In reply to Fernando Ramos

Create a new test case file for the different available merge tools. Right now it only tests the 'mergetool.vimdiff.layout' options. Other merge tools might be interested in adding their own tests here too.

---
 mergetools/vimdiff        |  2 +-
 t/t7609-mergetool--lib.sh | 17 +++++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100755 t/t7609-mergetool--lib.sh
mergetools/vimdiff +1 -1
index 8614253ef1..5085e4ad0e 100644
@@ -552,6 +552,7 @@ merge_cmd_help() {
 	esac
 
 	return 0
+
 }
 
 
@@ -594,4 +595,3 @@ if test -n "$GIT_MERGETOOL_VIMDIFF_UNITTESTS"
 then
 	run_unit_tests
 fi
-
t/t7609-mergetool--lib.sh new file +17 -0
new file mode 100755
index 0000000000..35cc287124
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+test_description='git mergetool
+
+Testing basic merge tools options'
+
+GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
+export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
+
+. ./test-lib.sh
+
+test_expect_success 'mergetool --tool=vimdiff creates the expected layout' '
+	GIT_MERGETOOL_VIMDIFF_UNITTESTS=1 bash $GIT_BUILD_DIR/mergetools/vimdiff
+'
+
+test_done
+
Signature · 1 line
2.34.0
#6 lore raw

Re: [PATCH v3 3/3] vimdiff: integrate layout tests in the unit tests framework ('t' folder)

Quoted 24 lines · Fernando Ramos

Create a new test case file for the different available merge tools. Right now it only tests the 'mergetool.vimdiff.layout' options. Other merge tools might be interested in adding their own tests here too.

---
 mergetools/vimdiff        |  2 +-
 t/t7609-mergetool--lib.sh | 17 +++++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100755 t/t7609-mergetool--lib.sh
mergetools/vimdiff +1 -0
index 8614253ef1..5085e4ad0e 100644
@@ -552,6 +552,7 @@ merge_cmd_help() {
 	esac
 
 	return 0
+
 }
 
 

mergetools/vimdiff if test -n "$GIT_MERGETOOL_VIMDIFF_UNITTESTS" · line 597

Quoted 4 lines
mergetools/vimdiff +0 -1
@@ -594,4 +595,3 @@ if test -n "$GIT_MERGETOOL_VIMDIFF_UNITTESTS"
 then
 	run_unit_tests
 fi
-

Stray unrelated whitespace changes...

Quoted 6 lines
t/t7609-mergetool--lib.sh new file +0 -0
new file mode 100755
index 0000000000..35cc287124

t/t7609-mergetool--lib.sh line 8

Quoted 8 lines
t/t7609-mergetool--lib.sh new file +8 -0
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+test_description='git mergetool
+
+Testing basic merge tools options'
+
+GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
+export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

You don't seem to need this particular boilerplate, no?

t/t7609-mergetool--lib.sh line 13

Quoted 5 lines
t/t7609-mergetool--lib.sh new file +5 -0
+
+. ./test-lib.sh
+
+test_expect_success 'mergetool --tool=vimdiff creates the expected layout' '
+	GIT_MERGETOOL_VIMDIFF_UNITTESTS=1 bash $GIT_BUILD_DIR/mergetools/vimdiff

Don't use "bash", or if you do there should be appropriate prereqs to check whether bash is there etc. See some existing tests that really do mean to use it.

#7 lore raw
In reply to Fernando Ramos
Quoted 3 lines · Fernando Ramos

* Use "$" inside arithmetic expressions $((...))
NOTE: "shellcheck" issues a warning stating that "$" is not needed inside arithmetic expressions.

Just a side note: I understand that [1] recommended adding the "$" inside arithmetic expressions, but by chance I happened to be browsing the history of CodingGuidelines and ran across 32b5fe7f0e (CodingGuidelines: drop arithmetic expansion advice to use "$x", 2020-05-04) which dropped[2] the recommendation to use "$" inside the expression. Anyhow, certainly not worth a re-roll.

By the way, since you've removed Bashisms, do you still need the #!/bin/bash at the top of the script?

[1]: https://lore.kernel.org/git/CAJDDKr5KZK3wpox6FJPOL9koPr=k5+qTzZtPPFEmg4iZsvwoog@mail.gmail.com/
[2]: https://lore.kernel.org/git/[email protected]/

#8 lore raw
Quoted 6 lines · Eric Sunshine

Just a side note: I understand that [1] recommended adding the "$" inside arithmetic expressions, but by chance I happened to be browsing the history of CodingGuidelines and ran across 32b5fe7f0e (CodingGuidelines: drop arithmetic expansion advice to use "$x", 2020-05-04) which dropped[2] the recommendation to use "$" inside the expression. Anyhow, certainly not worth a re-roll.

I don't mind preparing a v4 with this change. I also think it makes the code cleaner. I'll do that :)

Quoted 2 lines

By the way, since you've removed Bashisms, do you still need the #!/bin/bash at the top of the script?

Good catch. Will do.

I'll wait a few more days for extra comments and prepare a v4 with these changes. Thanks for the suggestions.