]> git.ipfire.org Git - thirdparty/git.git/commitdiff
git-merge-index.txt: wrap shell listing in "----"
authorMartin Ågren <martin.agren@gmail.com>
Sat, 7 Sep 2019 14:12:52 +0000 (16:12 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 9 Sep 2019 18:05:52 +0000 (11:05 -0700)
The example output of `git merge-index` has been enriched by a second
"column" of helpful comments. When Asciidoctor renders this, the cells
in that second column aren't aligned.

Fix this by marking the example shell session as a code listing by
wrapping it in "----". Also drop some of the horizontal space between
the two columns so that we fit into 80 columns. This changes the
rendering with both AsciiDoc and Asciidoctor. They now render this
identically, nicely aligned, and within 80 columns.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-merge-index.txt

index 02676fb39197d8c4ae33b3d6aa3e8fa27b8e3350..2ab84a91e5388ac5caf4a5f1e4725f4f58c9f499 100644 (file)
@@ -54,20 +54,24 @@ original is first. But the argument order to the 3-way merge program
 
 Examples:
 
-  torvalds@ppc970:~/merge-test> git merge-index cat MM
-  This is MM from the original tree.                   # original
-  This is modified MM in the branch A.                 # merge1
-  This is modified MM in the branch B.                 # merge2
-  This is modified MM in the branch B.                 # current contents
+----
+torvalds@ppc970:~/merge-test> git merge-index cat MM
+This is MM from the original tree.             # original
+This is modified MM in the branch A.           # merge1
+This is modified MM in the branch B.           # merge2
+This is modified MM in the branch B.           # current contents
+----
 
 or
 
-  torvalds@ppc970:~/merge-test> git merge-index cat AA MM
-  cat: : No such file or directory
-  This is added AA in the branch A.
-  This is added AA in the branch B.
-  This is added AA in the branch B.
-  fatal: merge program failed
+----
+torvalds@ppc970:~/merge-test> git merge-index cat AA MM
+cat: : No such file or directory
+This is added AA in the branch A.
+This is added AA in the branch B.
+This is added AA in the branch B.
+fatal: merge program failed
+----
 
 where the latter example shows how 'git merge-index' will stop trying to
 merge once anything has returned an error (i.e., `cat` returned an error