All of lore.kernel.org
 help / color / mirror / Atom feed
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: Sun, 27 Mar 2022 14:50:44 -0400	[thread overview]
Message-ID: <20220327185044.20781-1-levraiphilippeblain@gmail.com> (raw)
In-Reply-To: <001d3ecd-e1bd-39f4-5123-4a8b1bd1b5a8@gmail.com>

- 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

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
 Documentation/mergetools/vimdiff.txt | 81 +++++++++++++++-------------
 1 file changed, 44 insertions(+), 37 deletions(-)

diff --git a/Documentation/mergetools/vimdiff.txt b/Documentation/mergetools/vimdiff.txt
index 296bc76e98..1017527e7d 100644
--- a/Documentation/mergetools/vimdiff.txt
+++ b/Documentation/mergetools/vimdiff.txt
@@ -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).
-- 
2.29.2


  reply	other threads:[~2022-03-27 18:50 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-27 11:23 [PATCH v6 0/3] vimdiff: new implementation with layout support Fernando Ramos
2022-03-27 11:23 ` [PATCH v6 1/3] " Fernando Ramos
2022-03-27 16:47   ` Philippe Blain
2022-03-27 18:12     ` Fernando Ramos
2022-03-27 21:36   ` Junio C Hamano
2022-03-27 11:23 ` [PATCH v6 2/3] vimdiff: integrate layout tests in the unit tests framework ('t' folder) Fernando Ramos
2022-03-27 21:37   ` Junio C Hamano
2022-03-27 11:23 ` [PATCH v6 3/3] vimdiff: add tool documentation Fernando Ramos
2022-03-27 18:28   ` Philippe Blain
2022-03-27 18:50     ` Philippe Blain [this message]
2022-03-27 21:10     ` Fernando Ramos
2022-03-27 21:43       ` Junio C Hamano
2022-03-27 22:17         ` Fernando Ramos
2022-03-28  4:48   ` Bagas Sanjaya
2022-03-28  5:43     ` Junio C Hamano
2022-03-28 19:19       ` Fernando Ramos
2022-03-29  1:01 [PATCH v7 3/4] " Junio C Hamano
2022-03-29 12:54 ` [PATCH] fixup! " Philippe Blain
2022-03-29 16:03   ` Junio C Hamano

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=20220327185044.20781-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.