git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 6/7] git-merge-index.txt: wrap shell listing in "----"

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Sep 7, 2019, 14:12 UTC
Message-ID
<e948f00338e9a9f849d23fe7a88962cda34700fa.1567707999.git.martin.agren@gmail.com>
In-Reply-To
<cover.1567707999.git.martin.agren@gmail.com>

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>
---
 Documentation/git-merge-index.txt | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 02676fb391..2ab84a91e5 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -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
-- 
2.23.0
Previous: Martin ÅgrenNext: Jeff King
Message 8 of 10 in “Fix more AsciiDoc/tor differences”
  1. 0/7 Fix more AsciiDoc/tor differencesMartin Ågren, Sep 7, 2019
  2. 4/7 git-ls-remote.txt: wrap shell listing in "----"Martin Ågren, Sep 7, 2019
  3. 1/7 Documentation: wrap blocks with "--"Martin Ågren, Sep 7, 2019
  4. 3/7 Documentation: wrap config listings in "----"Martin Ågren, Sep 7, 2019
  5. 2/7 git-merge-base.txt: render indentations correctly under AsciidoctorMartin Ågren, Sep 7, 2019
  6. 5/7 git-receive-pack.txt: wrap shell [script] listing in "----"Martin Ågren, Sep 7, 2019
  7. 7/7 gitweb.conf.txt: switch pluses to backticks to help AsciidoctorMartin Ågren, Sep 7, 2019
  8. 6/7 git-merge-index.txt: wrap shell listing in "----"Martin Ågren, Sep 7, 2019
  9. Jeff KingSep 13, 2019
  10. Martin ÅgrenSep 13, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.