| Message ID | 20220327112307.151044-4-greenfoo@u92.eu (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | vimdiff: new implementation with layout support | expand |
Hi Fernando, Le 2022-03-27 à 07:23, Fernando Ramos a écrit : > 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) 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 :) > > 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 <greenfoo@u92.eu> > --- > 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 > > diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt > index cafbbef46a..5973ebd2dc 100644 > --- a/Documentation/config/mergetool.txt > +++ b/Documentation/config/mergetool.txt > @@ -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] ? > mergetool.hideResolved:: > During a merge Git will automatically resolve as many conflicts as > possible and write the 'MERGED' file containing conflict markers around > diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt > index e587c7763a..6c6aa29c5a 100644 > --- a/Documentation/git-mergetool.txt > +++ b/Documentation/git-mergetool.txt > @@ -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 > diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt > new file mode 100644 > index 0000000000..296bc76e98 > --- /dev/null > +++ b/Documentation/mergetools/vimdiff.txt > @@ -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) ? > +windows layout distributed in the following way: > + > + ------------------------------------------ > + | | | | > + | 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. > ("commit you are merging into", > +"common ancestor commit" and "commit you are merging from" respectively) > + > +"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 > +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. > +The precedence of the operators is this one (you can use parenthesis parentheses > to change > +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). > +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> | > + --------------------------------------------- > + | 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. > +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` > + > +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. > + > +Example: using `--tool=gvimdiff2` will open `gvim` with three columns (LOCAL, > +MERGED and REMOTE). > + > diff --git a/git-mergetool--lib.sh b/git-mergetool--lib.sh > index 542a6a75eb..956c276e1d 100644 > --- a/git-mergetool--lib.sh > +++ b/git-mergetool--lib.sh > @@ -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 > 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. > diff --git a/mergetools/vimdiff b/mergetools/vimdiff > index e3f442caf3..0380bff302 100644 > --- a/mergetools/vimdiff > +++ b/mergetools/vimdiff > @@ -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.
> > +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] ? 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? > 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 > 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 ...
Fernando Ramos <greenfoo@u92.eu> writes: > 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. > 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? 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 it
> 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 it > Thanks 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.
On 27/03/22 18.23, Fernando Ramos wrote: > +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."
Bagas Sanjaya <bagasdotme@gmail.com> writes: > On 27/03/22 18.23, Fernando Ramos wrote: >> +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." 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.
> 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 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.
diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt index cafbbef46a..5973ebd2dc 100644 --- a/Documentation/config/mergetool.txt +++ b/Documentation/config/mergetool.txt @@ -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 diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index e587c7763a..6c6aa29c5a 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -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 diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt new file mode 100644 index 0000000000..296bc76e98 --- /dev/null +++ b/Documentation/mergetools/vimdiff.txt @@ -0,0 +1,182 @@ +Description +^^^^^^^^^^^ + +When specifying `--tool=vimdiff` in `git mergetool` git will open vim with a 4 +windows layout distributed in the following way: + + ------------------------------------------ + | | | | + | LOCAL | BASE | REMOTE | + | | | | + ------------------------------------------ + | | + | MERGED | + | | + ------------------------------------------ + +"LOCAL", "BASE" and "REMOTE" are read-only buffers showing the contents of the +conflicting file in a specific git commit ("commit you are merging into", +"common ancestor commit" and "commit you are merging from" respectively) + +"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" which accepts a string where the following separators +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. + +The precedence of the operators is this one (you can use parenthesis to change +it): + + @ > + > / > , + +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> | + --------------------------------------------- + | LOCAL | | + |---------------------| | + | BASE | MERGED | + |---------------------| | + | REMOTE | | + --------------------------------------------- + + Note how in the third tab definition we need to use parenthesis to make "," + have precedence over "/". + +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` + +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" + +Example: using `--tool=gvimdiff2` will open `gvim` with three columns (LOCAL, +MERGED and REMOTE). + diff --git a/git-mergetool--lib.sh b/git-mergetool--lib.sh index 542a6a75eb..956c276e1d 100644 --- a/git-mergetool--lib.sh +++ b/git-mergetool--lib.sh @@ -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 } diff --git a/mergetools/vimdiff b/mergetools/vimdiff index e3f442caf3..0380bff302 100644 --- a/mergetools/vimdiff +++ b/mergetools/vimdiff @@ -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*)
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) 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 <greenfoo@u92.eu> --- 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