vimdiff: new implementation with layout support
v6 cover vimdiff: new implementation with layout support
Original cover letter (see v6 changes at the end):
---
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 individual 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 lines 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.
New in v4:
* Rebase on top of latest master
* Stop using "$" inside arithmetic expressions.
* Remove "!/bin/bash" from the top of the "vimdiff" script.
* Update comment explaining how the "vimdiff" script can be run.
* Fix spaces/tabs.
* Change the way unit tests are run (now the script is directly sourced instead of calling bash)
* Remove unnecessary "case/esac" structure.
* Fix typo in documentation
New in v5:
* Rebase on top of latest master
New in v6:
* Syntax corrections (spaces around parenthesis)
* Fix layout definition of "vimdiff1"
* Make clear how the old behaviour of the different variants (vimdiffN) is tested in the built in unit tests
* Move doc into a subsection inside "git help mergetool"
Fernando Ramos (3):
vimdiff: new implementation with layout support
vimdiff: integrate layout tests in the unit tests framework ('t'
folder)
vimdiff: add tool documentation
Documentation/config/mergetool.txt | 5 + Documentation/git-mergetool.txt | 7 + Documentation/mergetools/vimdiff.txt | 182 +++++++++ git-mergetool--lib.sh | 14 + mergetools/vimdiff | 553 +++++++++++++++++++++++++-- t/t7609-mergetool--lib.sh | 15 + 6 files changed, 748 insertions(+), 28 deletions(-) create mode 100644 Documentation/mergetools/vimdiff.txt create mode 100755 t/t7609-mergetool--lib.sh
Signature · 1 line
2.35.1
PATCH v6 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'.
Again, if you don't set "mergetool.vimdiff.layout" everything will work the same as before *but* the arguments used to call {n,g,}vim will be others (even if you don't/shouldn't notice it):
- git mergetool -t vimdiff
Quoted 1 line
Before this commit:
{n,g,}vim -f -d -c '4wincmd w | wincmd J' $LOCAL $BASE $REMOTE $MERGED
> After this commit:
{n,g,}vim -f -c "echo | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabdo windo diffthis" -c "tabfirst" $LOCAL $BASE $REMOTE $MERGED
- git mergetool -t vimdiff1
Quoted 1 line
Before this commit:
{n,g,}vim -f -d -c 'echon "..."' $LOCAL $REMOTE
> After this commit:
{n,g,}vim -f -c "echo | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis" -c "tabfirst" $LOCAL $BASE $REMOTE $MERGED
- git mergetool -t vimdiff2
Quoted 1 line
Before this commit:
{n,g,}vim -f -d -c 'wincmd l' $LOCAL $MERGED $REMOTE
> After this commit:
{n,g,}vim -f -c "echo | vertical split | 1b | wincmd l | vertical split | 4b | wincmd l | 3b | tabdo windo diffthis" -c "tabfirst" $LOCAL $BASE $REMOTE $MERGED
- git mergetool -t vimdiff3
Quoted 1 line
Before this commit:
{n,g,}vim -f -d -c 'hid | hid | hid' $LOCAL $REMOTE $BASE $MERGED
> After this commit:
{n,g,}vim -f -c "echo | 4b | bufdo diffthis" -c "tabfirst" $LOCAL $BASE $REMOTE $MERGED
Despite being different, I have manually verified that they generate the same layout as before.
--- mergetools/vimdiff | 547 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 519 insertions(+), 28 deletions(-)
mergetools/vimdiff +519 -28
@@ -1,49 +1,441 @@ +# 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 a script inside the unit tests framework folder ("t" folder) by +# sourcing this script and then manually calling "run_unit_tests", which +# will run 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\"" +} + + +################################################################################ +## 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,REMOTE" ;; *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() { + +translate_merge_tool_path () { case "$1" in nvimdiff*) echo nvim
@@ -57,14 +449,113 @@ 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 } + + +################################################################################ +## Unit tests (called from scripts inside the "t" folder) +################################################################################ + +run_unit_tests () { + # Function to make sure that we don't break anything when modifying this + # script. + + NUMBER_OF_TEST_CASES=16 + + TEST_CASE_01="(LOCAL,BASE,REMOTE)/MERGED" # default behaviour + TEST_CASE_02="@LOCAL,REMOTE" # when using vimdiff1 + TEST_CASE_03="LOCAL,MERGED,REMOTE" # when using vimdiff2 + TEST_CASE_04="MERGED" # when using vimdiff3 + TEST_CASE_05="LOCAL/MERGED/REMOTE" + TEST_CASE_06="(LOCAL/REMOTE),MERGED" + TEST_CASE_07="MERGED,(LOCAL/REMOTE)" + TEST_CASE_08="(LOCAL,REMOTE)/MERGED" + TEST_CASE_09="MERGED/(LOCAL,REMOTE)" + TEST_CASE_10="(LOCAL/BASE/REMOTE),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 | split | vertical split | 1b | wincmd l | vertical split | 2b | wincmd l | 3b | wincmd j | 4b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_02="-c \"echo | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_03="-c \"echo | vertical split | 1b | wincmd l | vertical split | 4b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_04="-c \"echo | 4b | bufdo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_05="-c \"echo | split | 1b | wincmd j | split | 4b | wincmd j | 3b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_06="-c \"echo | vertical split | split | 1b | wincmd j | 3b | wincmd l | 4b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_07="-c \"echo | vertical split | 4b | wincmd l | split | 1b | wincmd j | 3b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_08="-c \"echo | split | vertical split | 1b | wincmd l | 3b | wincmd j | 4b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_09="-c \"echo | split | 4b | wincmd j | vertical split | 1b | wincmd l | 3b | tabdo windo diffthis\" -c \"tabfirst\"" + EXPECTED_CMD_10="-c \"echo | vertical split | split | 1b | wincmd j | split | 2b | wincmd j | 3b | wincmd l | 4b | tabdo windo 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="LOCAL" + 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="MERGED" + 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 +}
Signature · 1 line
2.35.1
Hi Fernando,
Le 2022-03-27 à 07:23, Fernando Ramos a écrit :
--8<--
mergetools/vimdiff line 32
Quoted 6 lines
mergetools/vimdiff +6
-0+################################################################################ +## Internal functions (not meant to be used outside this script) +################################################################################ + +debug_print () { + # Send message to stderr if global variable DEBUG is set to "true"
This should also be GIT_MERGETOOL_VIMDIFF_DEBUG, right?
mergetools/vimdiff line 39
Quoted 7 lines
mergetools/vimdiff +7
-0+ + if test -n "$GIT_MERGETOOL_VIMDIFF_DEBUG" + then + >&2 echo "$@" + fi +} +
--8<--
mergetools/vimdiff line 296
Quoted 11 lines
mergetools/vimdiff +11
-0+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)...
Is this still TODO ?
Quoted 17 lines
mergetools/vimdiff +17
-0+ # 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"
Quoted 8 lines
mergetools/vimdiff line 32
Quoted 6 lines
mergetools/vimdiff +6
-0+################################################################################ +## Internal functions (not meant to be used outside this script) +################################################################################ + +debug_print () { + # Send message to stderr if global variable DEBUG is set to "true"This should also be
GIT_MERGETOOL_VIMDIFF_DEBUG, right?
Good catch! I'll fix it in v7.
Quoted 5 lines
Quoted 5 lines
mergetools/vimdiff +5
-0+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: + #
Quoted 8 lines
mergetools/vimdiff line 296
Quoted 6 lines
mergetools/vimdiff +6
-0+ # $ 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)...Is this still TODO ?
No. I need to point to "Documentation/mergetools/vimdiff.txt".
I also noticed that the next paragraph was also not updated after the delimiters were changed (from ";", "-" and "|" to "+", "/" and ",").
I'll fix both issues in v7.
Thanks!
I see these from "git apply".
<stdin>:102: trailing whitespace.debug_print () {
<stdin>:114: trailing whitespace.
# <stdin>:132: trailing whitespace. LAYOUT=$1
<stdin>:133: trailing whitespace.
CMD=$2 # This is a second (hidden) argument used for recursion
<stdin>:159: trailing whitespace.
# - AFTER : ( LOCAL , BASE ) / MERGED
PATCH v6 2/3 vimdiff: integrate layout tests in the unit tests framework ('t' folder)
In reply to Fernando RamosCreate a new test case file for the different available merge tools. Right now it only tests the 'mergetool.vimdiff.layout' option. Other merge tools might be interested in adding their own tests here too.
--- t/t7609-mergetool--lib.sh | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100755 t/t7609-mergetool--lib.sh
t/t7609-mergetool--lib.sh new file +15 -0
@@ -0,0 +1,15 @@ +#!/bin/sh + +test_description='git mergetool + +Testing basic merge tools options' + +. ./test-lib.sh + +test_expect_success 'mergetool --tool=vimdiff creates the expected layout' ' + . $GIT_BUILD_DIR/mergetools/vimdiff && + run_unit_tests +' + +test_done +
Signature · 1 line
2.35.1
Re: [PATCH v6 2/3] vimdiff: integrate layout tests in the unit tests framework ('t' folder)
Quoted 6 lines · Fernando Ramos
Create a new test case file for the different available merge tools. Right now it only tests the 'mergetool.vimdiff.layout' option. Other merge tools might be interested in adding their own tests here too.
Signed-off-by Fernando Ramos <[email protected]>---
.git/rebase-apply/patch:21: trailing whitespace.
. $GIT_BUILD_DIR/mergetools/vimdiff &&
.git/rebase-apply/patch:26: new blank line at EOF. +
PATCH v6 3/3 vimdiff: add tool documentation
In reply to Fernando RamosRunning '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)
In addition, a section has been added to "Documentation/git-mergetool.txt" to explain the new "layout" configuration option with examples.
--- Documentation/config/mergetool.txt | 5 + Documentation/git-mergetool.txt | 7 ++ Documentation/mergetools/vimdiff.txt | 182 +++++++++++++++++++++++++++ git-mergetool--lib.sh | 14 +++ mergetools/vimdiff | 6 + 5 files changed, 214 insertions(+) create mode 100644 Documentation/mergetools/vimdiff.txt
Documentation/config/mergetool.txt +5 -0
@@ -45,6 +45,11 @@ mergetool.meld.useAutoMerge:: value of `false` avoids using `--auto-merge` altogether, and is the default value. +mergetool.{n,g,}vimdiff.layout:: + The vimdiff backend uses this variable to control how its split + windows look like. See BACKEND SPECIFIC HINTS section of + linkgit:git-mergetool[1] for details. + mergetool.hideResolved:: During a merge Git will automatically resolve as many conflicts as possible and write the 'MERGED' file containing conflict markers around
Documentation/git-mergetool.txt +7 -0
@@ -113,6 +113,13 @@ Setting the `mergetool.keepBackup` configuration variable to `false` causes `git mergetool` to automatically remove the backup as files are successfully merged. +BACKEND SPECIFIC HINTS +---------------------- + +vimdiff +~~~~~~~ +include::mergetools/vimdiff.txt[] + GIT --- Part of the linkgit:git[1] suite
Documentation/mergetools/vimdiff.txt new file +182 -0
182 lines not on this page · raw message
git-mergetool--lib.sh +14 -0
@@ -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 +6 -0
@@ -435,6 +435,12 @@ merge_cmd () { } +merge_cmd_help () { + echo "Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section." + return 0 +} + + translate_merge_tool_path () { case "$1" in nvimdiff*)
Signature · 1 line
2.35.1
Re: [PATCH v6 3/3] vimdiff: add tool documentation
Hi Fernando,
Le 2022-03-27 à 07:23, Fernando Ramos a écrit :
Quoted 9 lines
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.
Quoted 4 lines
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)
This is a very nice addition, which should help new users understanding what these merge tools are. I remember myself looking for executables name 'vimdiff2' or 'vimdiff3' on my system and not finding them :)
Quoted 20 lines
In addition, a section has been added to "
Documentation/git-mergetool.txt" to explain the new "layout" configuration option with examples.Signed-off-by Fernando Ramos <[email protected]>--- Documentation/config/mergetool.txt | 5 + Documentation/git-mergetool.txt | 7 ++ Documentation/mergetools/vimdiff.txt | 182 +++++++++++++++++++++++++++ git-mergetool--lib.sh | 14 +++ mergetools/vimdiff | 6 + 5 files changed, 214 insertions(+) create mode 100644 Documentation/mergetools/vimdiff.txtDocumentation/config/mergetool.txt +0
-0
Documentation/config/mergetool.txt mergetool.meld.useAutoMerge:: · line 52
Quoted 8 lines
Documentation/config/mergetool.txt +5
-0@@ -45,6 +45,11 @@ mergetool.meld.useAutoMerge:: value of `false` avoids using `--auto-merge` altogether, and is the default value. +mergetool.{n,g,}vimdiff.layout:: + The vimdiff backend uses this variable to control how its split + windows look like. See BACKEND SPECIFIC HINTS section of + linkgit:git-mergetool[1] for details. +
I generated the man page for 'git-mergetool' and this bit is included in the Configuration section, that's great. However, it feels a little weird to read "see BACKEND SPECIFIC HINTS section of linkgit:git-mergetool[1]" there, since that's the help page I'm already reading. So maybe it would be nice to use an Asciidoc 'ifndef::git-mergetool[]' directive here to hide the "of linkgit:git-mergetool[1]" bit if the current page is git-mergetool[1] ?
Quoted 27 lines
Documentation/config/mergetool.txt +0
-0mergetool.hideResolved:: During a merge Git will automatically resolve as many conflicts as possible and write the 'MERGED' file containing conflict markers aroundDocumentation/git-mergetool.txt +7
-0@@ -113,6 +113,13 @@ Setting the `mergetool.keepBackup` configuration variable to `false` causes `git mergetool` to automatically remove the backup as files are successfully merged. +BACKEND SPECIFIC HINTS +---------------------- + +vimdiff +~~~~~~~ +include::mergetools/vimdiff.txt[] + GIT --- Part of the linkgit:git[1] suiteDocumentation/mergetools/vimdiff.txt new file +0
-0
Documentation/mergetools/vimdiff.txt line 4
Quoted 4 lines
Documentation/mergetools/vimdiff.txt new file +4
-0@@ -0,0 +1,182 @@ +Description +^^^^^^^^^^^ + +When specifying `--tool=vimdiff` in `git mergetool` git will open vim with a 4
s/git/Git/, s/vim/Vim/ (here and below) ?
Quoted 4 lines
Documentation/mergetools/vimdiff.txt new file +4
-0+windows layout distributed in the following way: + + ------------------------------------------ + | | | |
Documentation/mergetools/vimdiff.txt
Quoted 10 lines
Documentation/mergetools/vimdiff.txt new file +10
-0+ | LOCAL | BASE | REMOTE | + | | | | + ------------------------------------------ + | | + | MERGED | + | | + ------------------------------------------ + +"LOCAL", "BASE" and "REMOTE" are read-only buffers showing the contents of the +conflicting file in a specific git commit
"in specific commits" would read sightly better, I think.
Documentation/mergetools/vimdiff.txt
Quoted 12 lines
("commit you are merging into",
+"common ancestor commit" and "commit you are merging from" respectively)Documentation/mergetools/vimdiff.txt new file +10
-0+ +"MERGED" is a writable buffer where you have to resolve the conflicts (using the +other read-only buffers as a reference). Once you are done, save and exit "vim" +as usual (":wq") or, if you want to abort, exit using ":cq". + +Layout configuration +^^^^^^^^^^^^^^^^^^^^ + +You can change the windows layout used by vim by setting configuration variable +"mergetool.vimdiff.layout"
we prefer backticks for configuration variables: mergetool.vimdiff.layout
which accepts a string where the following separators
Documentation/mergetools/vimdiff.txt line 36
Quoted 7 lines
Documentation/mergetools/vimdiff.txt new file +7
-0+have special meaning: + + - "+" is used to "open a new tab" + - "," is used to "open a new vertical split" + - "/" is used to "open a new horizontal split" + - "@" is used to indicate which is the file containing the final version after + solving the conflicts. In not present, "MERGED" will be used by default.
s/In/If/
Also, I would use backticks instead of double quotes for the separator:
- + is used to "open a new tab"
etc.
Quoted 1 line
+The precedence of the operators is this one (you can use parenthesis
parentheses
Documentation/mergetools/vimdiff.txt line 42
Quoted 5 lines
to change
Documentation/mergetools/vimdiff.txt new file +4
-0+it): + + @ > + > / > , +
I think it would be slightly better for the separators to be individually formatted, like this:
@ > + > / > ,
this way the angle brackets are typefaced differently (at least in HTML).
Quoted 103 lines
Documentation/mergetools/vimdiff.txt new file +103
-0+Let's see some examples to understand how it works: + + * layout = "(LOCAL,BASE,REMOTE)/MERGED" + + This is exactly the same as the default layout we have already seen. + + Note that "/" has precedence over "," and thus the parenthesis are not + needed in this case. The next layout definition is equivalent: + + layout = "LOCAL,BASE,REMOTE / MERGED" + + * layout = "LOCAL,MERGED,REMOTE" + + If, for some reason, we are not interested in the "BASE" buffer. + + ------------------------------------------ + | | | | + | | | | + | LOCAL | MERGED | REMOTE | + | | | | + | | | | + ------------------------------------------ + + * layout = "MERGED" + + Only the "MERGED" buffer will be shown. Note, however, that all the other + ones are still loaded in vim, and you can access them with the "buffers" + command. + + ------------------------------------------ + | | + | | + | MERGED | + | | + | | + ------------------------------------------ + + * layout = "@LOCAL,REMOTE" + + When "MERGED" is not present in the layout, you must "mark" one of the + buffers with an asterisk. That will become the buffer you need to edit and + save after resolving the conflicts. + + ------------------------------------------ + | | | + | | | + | | | + | LOCAL | REMOTE | + | | | + | | | + | | | + ------------------------------------------ + + * layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE" + + Three tabs will open: the first one is a copy of the default layout, while + the other two only show the differences between "BASE" and "LOCAL" and + "BASE" and "REMOTE" respectively. + + ------------------------------------------ + | <TAB #1> | TAB #2 | TAB #3 | | + ------------------------------------------ + | | | | + | LOCAL | BASE | REMOTE | + | | | | + ------------------------------------------ + | | + | MERGED | + | | + ------------------------------------------ + + ------------------------------------------ + | TAB #1 | <TAB #2> | TAB #3 | | + ------------------------------------------ + | | | + | | | + | | | + | BASE | LOCAL | + | | | + | | | + | | | + ------------------------------------------ + + ------------------------------------------ + | TAB #1 | TAB #2 | <TAB #3> | | + ------------------------------------------ + | | | + | | | + | | | + | BASE | REMOTE | + | | | + | | | + | | | + ------------------------------------------ + + * layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL/BASE/REMOTE),MERGED" + + Same as the previous example, but adds a fourth tab with the same + information as the first tab, with a different layout. + + --------------------------------------------- + | TAB #1 | TAB #2 | TAB #3 | <TAB #4> | + ---------------------------------------------
Documentation/mergetools/vimdiff.txt line 155
Quoted 10 lines
Documentation/mergetools/vimdiff.txt new file +10
-0+ | LOCAL | | + |---------------------| | + | BASE | MERGED | + |---------------------| | + | REMOTE | | + --------------------------------------------- + + Note how in the third tab definition we need to use parenthesis to make "," + have precedence over "/". +
This whole section above needs some indentation work to format nicely in Asciidoc/ Asciidoctor. I've fixed it and will send a 'fixup' patch as a reply.
Quoted 13 lines
Documentation/mergetools/vimdiff.txt new file +13
-0+Variants +^^^^^^^^ + +Instead of `--tool=vimdiff`, you can also use one of these other variants: + + * `--tool=gvimdiff`, to open gvim instead of vim. + + * `--tool=nvimdiff`, to open nvim (`neovim`) instead of vim. + +When using these variants, in order to specify a custom layout you will have to +set configuration variables `mergetool.gvimdiff.layout` and +`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout` +
Documentation/mergetools/vimdiff.txt line 178
Quoted 10 lines
Documentation/mergetools/vimdiff.txt new file +10
-0+In addition, for backwards compatibility with previous git versions,> you can +also append `1`, `2` or `3` to either `vimdiff` or any of the variants (ex: +`vimdiff3`, `nvimdiff1`, etc...) to use a predefined layout. +In other words, using `--tool=[g,n,]vimdiffx` is the same as using +`--tool=[g,n,]vimdiff` and setting configuration variable +`mergetool.[g,n,]vimdiff.layout` to... + + * x=1 --> "@LOCAL, REMOTE" + * x=2 --> "LOCAL, MERGED, REMOTE" + * x=3 --> "MERGED"
This '-->' arrow also causes trouble with Asciidoc's HTML generator. I've also fixed it in the patch I'll send as a reply.
Quoted 11 lines
Documentation/mergetools/vimdiff.txt new file +4
-0+ +Example: using `--tool=gvimdiff2` will open `gvim` with three columns (LOCAL, +MERGED and REMOTE). +git-mergetool--lib.sh +0
-0@@ -64,6 +64,12 @@ $(list_tool_variants)" fi shown_any=yes
git-mergetool--lib.sh $(list_tool_variants)" · line 75
Quoted 10 lines
git-mergetool--lib.sh +6
-0printf "%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
I've tried the option and it gives something like this:
$ ./bin-wrappers/git mergetool --tool-help 'git mergetool --tool=<tool>' may be set to one of the following: emerge opendiff vimdiff Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. vimdiff1 Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. # etc.
This is OK, but adds a lot of lines to the output. Maybe we could display the help on the same line ? Something like:
$ ./bin-wrappers/git mergetool --tool-help 'git mergetool --tool=<tool>' may be set to one of the following: emerge opendiff vimdiff Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. vimdiff1 Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. # etc.
Quoted 5 lines
mergetools/vimdiff +0
-0
mergetools/vimdiff merge_cmd () { · line 443
Quoted 9 lines
mergetools/vimdiff +6
-0@@ -435,6 +435,12 @@ merge_cmd () { } +merge_cmd_help () { + echo "Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section." + return 0 +} + +
Maybe a simple "Use Vim. " before "Layout can be customized." would be nice, as then other tools whose names in 'git mergetool' are not directly related to the executable named could then be listed similarly:
$ ./bin-wrappers/git mergetool --tool-help 'git mergetool --tool=<tool>' may be set to one of the following: emerge Use Emacs' Emerge. opendiff Use FileMerge. vimdiff Use Vim. Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. vimdiff1 Use Vim. Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. # etc.
PATCH 1/1 fixup! vimdiff: add tool documentation
- Use Asciidoc's syntax for "list continuation" and "open block" [1]
- Remove '-->' which mixes up the parser
[1] https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation
--- Documentation/mergetools/vimdiff.txt | 81 +++++++++++++++------------- 1 file changed, 44 insertions(+), 37 deletions(-)
Documentation/mergetools/vimdiff.txt +44 -37
@@ -42,18 +42,20 @@ it): Let's see some examples to understand how it works: - * layout = "(LOCAL,BASE,REMOTE)/MERGED" +* `layout = "(LOCAL,BASE,REMOTE)/MERGED"` ++ +-- +This is exactly the same as the default layout we have already seen. - This is exactly the same as the default layout we have already seen. - - Note that "/" has precedence over "," and thus the parenthesis are not - needed in this case. The next layout definition is equivalent: +Note that "/" has precedence over "," and thus the parenthesis are not +needed in this case. The next layout definition is equivalent: layout = "LOCAL,BASE,REMOTE / MERGED" - - * layout = "LOCAL,MERGED,REMOTE" - - If, for some reason, we are not interested in the "BASE" buffer. +-- +* `layout = "LOCAL,MERGED,REMOTE"` ++ +-- +If, for some reason, we are not interested in the "BASE" buffer. ------------------------------------------ | | | |
@@ -62,12 +64,13 @@ Let's see some examples to understand how it works: | | | | | | | | ------------------------------------------ - - * layout = "MERGED" - - Only the "MERGED" buffer will be shown. Note, however, that all the other - ones are still loaded in vim, and you can access them with the "buffers" - command. +-- +* `layout = "MERGED"` ++ +-- +Only the "MERGED" buffer will be shown. Note, however, that all the other +ones are still loaded in vim, and you can access them with the "buffers" +command. ------------------------------------------ | |
@@ -76,12 +79,13 @@ Let's see some examples to understand how it works: | | | | ------------------------------------------ - - * layout = "@LOCAL,REMOTE" - - When "MERGED" is not present in the layout, you must "mark" one of the - buffers with an asterisk. That will become the buffer you need to edit and - save after resolving the conflicts. +-- +* `layout = "@LOCAL,REMOTE"` ++ +-- +When "MERGED" is not present in the layout, you must "mark" one of the +buffers with an asterisk. That will become the buffer you need to edit and +save after resolving the conflicts. ------------------------------------------ | | |
@@ -92,12 +96,13 @@ Let's see some examples to understand how it works: | | | | | | ------------------------------------------ - - * layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE" - - Three tabs will open: the first one is a copy of the default layout, while - the other two only show the differences between "BASE" and "LOCAL" and - "BASE" and "REMOTE" respectively. +-- +* `layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE"` ++ +-- +Three tabs will open: the first one is a copy of the default layout, while +the other two only show the differences between "BASE" and "LOCAL" and +"BASE" and "REMOTE" respectively. ------------------------------------------ | <TAB #1> | TAB #2 | TAB #3 | |
@@ -134,11 +139,12 @@ Let's see some examples to understand how it works: | | | | | | ------------------------------------------ - - * layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL/BASE/REMOTE),MERGED" - - Same as the previous example, but adds a fourth tab with the same - information as the first tab, with a different layout. +-- +* `layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL/BASE/REMOTE),MERGED"` ++ +-- +Same as the previous example, but adds a fourth tab with the same +information as the first tab, with a different layout. --------------------------------------------- | TAB #1 | TAB #2 | TAB #3 | <TAB #4> |
@@ -150,8 +156,9 @@ Let's see some examples to understand how it works: | REMOTE | | --------------------------------------------- - Note how in the third tab definition we need to use parenthesis to make "," - have precedence over "/". +Note how in the third tab definition we need to use parenthesis to make "," +have precedence over "/". +-- Variants ^^^^^^^^
@@ -173,9 +180,9 @@ In other words, using `--tool=[g,n,]vimdiffx` is the same as using `--tool=[g,n,]vimdiff` and setting configuration variable `mergetool.[g,n,]vimdiff.layout` to... - * x=1 --> "@LOCAL, REMOTE" - * x=2 --> "LOCAL, MERGED, REMOTE" - * x=3 --> "MERGED" + * `x=1`: `"@LOCAL, REMOTE"` + * `x=2`: `"LOCAL, MERGED, REMOTE"` + * `x=3`: `"MERGED"` Example: using `--tool=gvimdiff2` will open `gvim` with three columns (LOCAL, MERGED and REMOTE).
Signature · 1 line
2.29.2
Re: [PATCH v6 3/3] vimdiff: add tool documentation
In reply to Philippe BlainQuoted 4 lines
Quoted 4 lines
Documentation/config/mergetool.txt +4
-0+mergetool.{n,g,}vimdiff.layout:: + The vimdiff backend uses this variable to control how its split + windows look like. See BACKEND SPECIFIC HINTS section of + linkgit:git-mergetool[1] for details.
Quoted 8 lines
Quoted 1 line
+
I generated the man page for 'git-mergetool' and this bit is included in the Configuration section, that's great. However, it feels a little weird to read "see BACKEND SPECIFIC HINTS section of linkgit:git-mergetool[1]" there, since that's the help page I'm already reading. So maybe it would be nice to use an Asciidoc 'ifndef::git-mergetool[]' directive here to hide the "of linkgit:git-mergetool[1]" bit if the current page is git-mergetool[1] ?
Good call. I tried this:
mergetool.{n,g,}vimdiff.layout::
The vimdiff backend uses this variable to control how its split windows look like. See BACKEND SPECIFIC HINTS section
ifndef::git-mergetool[]
(on linkgit:git-mergetool[1])
endif::[]
for details.
...does it look good?
I'm asking because I ran "make doc" and the generated man page always contains the extra piece. When are those asciidoc directives processed? Should two versions of the same man page be generated?
Quoted 2 lines
This whole section above needs some indentation work to format nicely in Asciidoc/ Asciidoctor. I've fixed it and will send a 'fixup' patch as a reply.
Thanks! I will include your patch in v7
Quoted 10 lines
This is OK, but adds a lot of lines to the output. Maybe we could display the help on the same line ? Something like:
$ ./bin-wrappers/git mergetool --tool-help 'git mergetool --tool=<tool>' may be set to one of the following: emerge opendiff vimdiff Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. vimdiff1 Layout can be customized. Run 'git help mergetool' and check the 'BACKEND SPECIFIC HINTS' section. # etc.
Yes. It looks nicer in one line. In addition, right now it doesn't offer enough information to figure out the difference among variants (vimdiff vs vimdiff1 vs ...) that's why I'm going to update v7 to print something like this following your advice:
$ ./bin-wrappers/git mergetool --tool-help
'git mergetool --tool=<tool>' may be set to one of the following:
araxis
meld
vimdiff Use Vim with a custom layout (see `git help mergetool`'s `BACKEND SPECIFIC HINTS` section).
vimdiff1 Use Vim with a 2 panes layout (LOCAL and REMOTE)
vimdiff2 Use Vim with a 3 panes layout (LOCAL, MERGED and REMOTE)
vimdiff3 Use Vim where only the MERGED file is shown
...Re: [PATCH v6 3/3] vimdiff: add tool documentation
Quoted 3 lines · Fernando Ramos
Good call. I tried this:
mergetool.{n,g,}vimdiff.layout::
It is not like we have infinite variants of these. Spelling them out like
mergetool.vimdiff.layout::
mergetool.gvimdiff.layout::
mergetool.nvimdiff.layout::
would probably be a better idea.
Quoted 7 lines
The vimdiff backend uses this variable to control how its split windows look like. See BACKEND SPECIFIC HINTS section
ifndef::git-mergetool[]
(on linkgit:git-mergetool[1])
endif::[]
for details.
Quoted 5 lines
...does it look good?
I'm asking because I ran "make doc" and the generated man page always contains the extra piece. When are those asciidoc directives processed? Should two versions of the same man page be generated?
Are you signalling the above part that it is (or isn't) included in git-mergetool.txt by defining
:git-mergetool: 1
before the piece gets included with
include::config/mergetool.txt
See for example how git-rev-list.txt tweaks what gets included from rev-list-description.txt by doing:
'git rev-list' [<options>] <commit>... [[--] <path>...]
DESCRIPTION
-----------
:git-rev-list: 1
include::rev-list-description.txt[]
'rev-list' is a very essential Git command, since itRe: [PATCH v6 3/3] vimdiff: add tool documentation
Quoted 12 lines
Are you signalling the above part that it is (or isn't) included in git-mergetool.txt by defining
:git-mergetool: 1
before the piece gets included with
include::config/mergetool.txt
See for example how git-rev-list.txt tweaks what gets included from rev-list-description.txt by doing:
Quoted 10 lines
'git rev-list' [<options>] <commit>... [[--] <path>...]
DESCRIPTION
-----------
:git-rev-list: 1
include::rev-list-description.txt[]
'rev-list' is a very essential Git command, since itThanks for the hint. It is now working as expected. I'll include the fix in v7 together with the other fixes that prevent git apply from executing cleanly.
Re: [PATCH v6 3/3] vimdiff: add tool documentation
In reply to Fernando RamosDocumentation/mergetools/vimdiff.txt line 168
Quoted 4 lines · Fernando Ramos
Documentation/mergetools/vimdiff.txt new file +4
-0+When using these variants, in order to specify a custom layout you will have to +set configuration variables `mergetool.gvimdiff.layout` and +`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout` +
What about this wording?
"These variants also have corresponding layout configuration named
mergetool.gvimdiff.layout and mergetool.nvimdiff.layout, respectively."
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH v6 3/3] vimdiff: add tool documentation
Quoted 10 lines · Bagas Sanjaya
Documentation/mergetools/vimdiff.txt line 168
Quoted 4 lines · Fernando Ramos
Documentation/mergetools/vimdiff.txt new file +4
-0+When using these variants, in order to specify a custom layout you will have to +set configuration variables `mergetool.gvimdiff.layout` and +`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout` +What about this wording?
"These variants also have corresponding layout configuration named
mergetool.gvimdiff.layoutandmergetool.nvimdiff.layout, respectively."
Hmph. The wording aside, is it a good design that you have to set gvimdiff.layout if you use gvim and your setting to vimdiff.layout has no effect when you are using nvim or gvim?
What is the reason why a user may want to specify them separately?
* I want to use this layout when using plain vim but gvim is so different that I want to use a different one from usability's point of view.
* The layout I want to use with plain vim, when fed to gvim or nvim, would totally make them misbehave. I cannot reuse the same layout even if I wanted to.
* Depending on the kind of conflict I deal with, I want to use different layouts, but there is no easy mechanism to choose between multiple values I give to mergetool.vimdiff.layout, so I use one layout for vimdiff and another for gvimdiff, and depending on the layout I want to use, I switch between vimdiff and gvimdiff.
* Something else?
If on the other hand, a user may want to stick to a single layout no matter which variant of vim is used, it may make more sense to just use a single mergetool.vimdiff.layout across all the different variants of vim implementations, and possibly, have their own one override the most generic "vimdiff" one. E.g. gvimdiff would use mergetool.gvimdiff.layout if exists, or mergetool.vimdiff.layout otherwise.
I dunno.
Re: [PATCH v6 3/3] vimdiff: add tool documentation
Quoted 19 lines
What is the reason why a user may want to specify them separately?
* I want to use this layout when using plain vim but gvim is so different that I want to use a different one from usability's point of view.
* The layout I want to use with plain vim, when fed to gvim or nvim, would totally make them misbehave. I cannot reuse the same layout even if I wanted to.
* Depending on the kind of conflict I deal with, I want to use different layouts, but there is no easy mechanism to choose between multiple values I give to mergetool.vimdiff.layout, so I use one layout for vimdiff and another for gvimdiff, and depending on the layout I want to use, I switch between vimdiff and gvimdiff.
* Something else?
Quoted 7 lines
If on the other hand, a user may want to stick to a single layout no matter which variant of vim is used, it may make more sense to just use a single mergetool.vimdiff.layout across all the different variants of vim implementations, and possibly, have their own one override the most generic "vimdiff" one. E.g. gvimdiff would use mergetool.gvimdiff.layout if exists, or mergetool.vimdiff.layout otherwise.
I think I agree. From the three reasons you mention, only the third one makes some sense, and even that one is too weak to justify having different configuration option names.
I'll only leave mergetool.vimdiff.layout in v7, which will affect all three variants.