From: Philippe Blain <levraiphilippeblain@gmail.com>
To: git@vger.kernel.org
Cc: Fernando Ramos <greenfoo@u92.eu>,
gitster@pobox.com, davvid@gmail.com, sunshine@sunshineco.com,
seth@eseth.com, rogi@skylittlesystem.org
Subject: [PATCH] fixup! vimdiff: add tool documentation
Date: Tue, 29 Mar 2022 08:54:00 -0400 [thread overview]
Message-ID: <20220329125400.63337-1-levraiphilippeblain@gmail.com> (raw)
In-Reply-To: <xmqqy20ty3k6.fsf@gitster.g>
Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
Hi Junio, Fernando,
I think the canonical Asciidoc way would be to use a listing block
(start and end the block with '----', and not indenting the lines
at all, as is done in a few places in the docs), but in this case
the parser gets confused about the several dashes in the content of
the block. So we can use a "literal block" instead [1].
[1] https://docs.asciidoctor.org/asciidoc/latest/verbatim/literal-blocks/
Documentation/mergetools/vimdiff.txt | 174 ++++++++++++++-------------
1 file changed, 90 insertions(+), 84 deletions(-)
diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt
index f63fc48c29..1cc9c133f9 100644
--- a/Documentation/mergetools/vimdiff.txt
+++ b/Documentation/mergetools/vimdiff.txt
@@ -3,17 +3,17 @@ 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 | REMOTE |
+| | | |
+------------------------------------------
+| |
+| MERGED |
+| |
+------------------------------------------
+....
`LOCAL`, `BASE` and `REMOTE` are read-only buffers showing the contents of the
conflicting file in specific commits ("commit you are merging into", "common
ancestor commit" and "commit you are merging from" respectively)
@@ -56,14 +56,15 @@ needed in this case. The next layout definition is equivalent:
+
--
If, for some reason, we are not interested in the `BASE` buffer.
-
- ------------------------------------------
- | | | |
- | | | |
- | LOCAL | MERGED | REMOTE |
- | | | |
- | | | |
- ------------------------------------------
+....
+------------------------------------------
+| | | |
+| | | |
+| LOCAL | MERGED | REMOTE |
+| | | |
+| | | |
+------------------------------------------
+....
--
* `layout = "MERGED"`
+
@@ -71,14 +72,15 @@ If, for some reason, we are not interested in the `BASE` buffer.
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 |
- | |
- | |
- ------------------------------------------
+....
+------------------------------------------
+| |
+| |
+| MERGED |
+| |
+| |
+------------------------------------------
+....
--
* `layout = "@LOCAL,REMOTE"`
+
@@ -86,16 +88,17 @@ command.
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 |
- | | |
- | | |
- | | |
- ------------------------------------------
+....
+------------------------------------------
+| | |
+| | |
+| | |
+| LOCAL | REMOTE |
+| | |
+| | |
+| | |
+------------------------------------------
+....
--
* `layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE"`
+
@@ -103,59 +106,62 @@ save after resolving the conflicts.
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 |
- | | |
- | | |
- | | |
- ------------------------------------------
+....
+------------------------------------------
+| <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 | |
- ---------------------------------------------
-
+....
+---------------------------------------------
+| 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 `/`.
--
--
2.29.2
next prev parent reply other threads:[~2022-03-29 12:55 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-28 22:30 [PATCH v7 0/4] vimdiff: new implementation with layout support Fernando Ramos
2022-03-28 22:30 ` [PATCH v7 1/4] " Fernando Ramos
2022-03-28 22:30 ` [PATCH v7 2/4] vimdiff: integrate layout tests in the unit tests framework ('t' folder) Fernando Ramos
2022-03-28 22:30 ` [PATCH v7 3/4] vimdiff: add tool documentation Fernando Ramos
2022-03-28 22:39 ` Fernando Ramos
2022-03-29 1:01 ` Junio C Hamano
2022-03-29 12:54 ` Philippe Blain [this message]
2022-03-29 16:03 ` [PATCH] fixup! " Junio C Hamano
2022-03-29 14:07 ` [PATCH v7 3/4] " Philippe Blain
2022-03-29 16:35 ` Junio C Hamano
2022-03-29 17:08 ` Philippe Blain
2022-03-29 17:29 ` Philippe Blain
2022-03-28 22:30 ` [PATCH v7 4/4] vimdiff: add description to already existing diff/merge tools Fernando Ramos
2022-03-29 16:38 ` Junio C Hamano
2022-03-29 17:24 ` Philippe Blain
2022-03-29 18:50 ` Junio C Hamano
2022-03-29 22:39 ` Fernando Ramos
2022-03-29 14:10 ` [PATCH v7 0/4] vimdiff: new implementation with layout support Philippe Blain
2022-03-29 21:45 ` Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 0/5] " Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 1/5] " Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 2/5] vimdiff: integrate layout tests in the unit tests framework ('t' folder) Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 3/5] vimdiff: add tool documentation Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 4/5] mergetools: add description to all diff/merge tools Fernando Ramos
2022-03-29 22:44 ` [PATCH v8 5/5] mergetools: add tools description to `git help config` Fernando Ramos
2022-03-30 12:43 ` Philippe Blain
2022-03-30 18:33 ` Fernando Ramos
2022-03-30 18:45 ` Philippe Blain
2022-03-30 19:19 ` [PATCH v9 0/4] vimdiff: new implementation with layout support Fernando Ramos
2022-03-30 19:19 ` [PATCH v9 1/4] " Fernando Ramos
2022-03-30 19:19 ` [PATCH v9 2/4] vimdiff: integrate layout tests in the unit tests framework ('t' folder) Fernando Ramos
2022-03-30 19:19 ` [PATCH v9 3/4] vimdiff: add tool documentation Fernando Ramos
2022-04-03 20:02 ` Philippe Blain
2022-04-03 22:44 ` Junio C Hamano
2022-04-04 20:00 ` Fernando Ramos
2022-04-04 21:38 ` Junio C Hamano
2022-03-30 19:19 ` [PATCH v9 4/4] mergetools: add description to all diff/merge tools Fernando Ramos
-- strict thread matches above, loose matches on Subject: below --
2022-03-27 18:28 [PATCH v6 3/3] vimdiff: add tool documentation Philippe Blain
2022-03-27 18:50 ` [PATCH] fixup! " Philippe Blain
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220329125400.63337-1-levraiphilippeblain@gmail.com \
--to=levraiphilippeblain@gmail.com \
--cc=davvid@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=greenfoo@u92.eu \
--cc=rogi@skylittlesystem.org \
--cc=seth@eseth.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).