merge-strategies.txt: add coverage of the `ort` merge strategy

[thirdparty/git.git] / Documentation / merge-strategies.txt

diff --git a/Documentation/merge-strategies.txt b/Documentation/merge-strategies.txt
index b54bcf68f2dd4fac4770a0c068daa327a0cd93d2..210f0f850b24f082037f6a653d6a1409c2f035c6 100644 (file)
--- a/Documentation/merge-strategies.txt
+++ b/Documentation/merge-strategies.txt
@@ -95,6 +95,20 @@ subtree[=<path>];;
        is prefixed (or stripped from the beginning) to make the shape of
        two trees to match.
 
+ort::
+       This is meant as a drop-in replacement for the `recursive`
+       algorithm (as reflected in its acronym -- "Ostensibly
+       Recursive's Twin"), and will likely replace it in the future.
+       It fixes corner cases that the `recursive` strategy handles
+       suboptimally, and is significantly faster in large
+       repositories -- especially when many renames are involved.
++
+The `ort` strategy takes all the same options as `recursive`.
+However, it ignores three of those options: `no-renames`,
+`patience` and `diff-algorithm`.  It always runs with rename
+detection (it handles it much faster than `recursive` does), and
+it specifically uses `diff-algorithm=histogram`.
+
 resolve::
        This can only resolve two heads (i.e. the current branch
        and another branch you pulled from) using a 3-way merge