Recommend zdiff3 merge.conflictStyle (#1260)

dandavison · Oct 29, 2024 · 4f207f7 · 4f207f7
1 parent 9c8f40e
commit 4f207f7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@
     # light = true
 
 [merge]
-    conflictstyle = diff3
+    conflictstyle = zdiff3
 ```
 
 Delta has many features and is very customizable; please see the [user manual](https://dandavison.github.io/delta/).

diff --git a/manual/src/get-started.md b/manual/src/get-started.md
@@ -17,5 +17,5 @@
     # light = true
 
 [merge]
-    conflictstyle = diff3
+    conflictstyle = zdiff3
 ```
diff --git a/manual/src/merge-conflicts.md b/manual/src/merge-conflicts.md
@@ -1,13 +1,14 @@
 # Merge conflicts
 
-Consider setting
+Consider setting [`merge.conflictStyle`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-mergeconflictStyle) to `zdiff3`:
 
 ```gitconfig
 [merge]
-    conflictstyle = diff3
+    conflictStyle = zdiff3
 ```
 
-With that setting, when a merge conflict is encountered, delta will display diffs between the ancestral commit and each of the two merge parents:
+With that setting, when a merge conflict is encountered, Git will display merge conflicts with the contents of the merge base as well.
+delta will then display this as two diffs, from the ancestor to each side of the conflict:
 
 <table><tr><td><img width=500px src="https://user-images.githubusercontent.com/52205/144783121-bb549100-69d8-41b8-ac62-1704f1f7b43e.png" alt="image" /></td></tr></table>