[02/10] directory-rename-detection.txt: small updates due to merge-ort optimizations

Commit Message

Elijah Newren Aug. 3, 2021, 3:35 p.m. UTC

From: Elijah Newren <[e-mail]>

In commit 0c4fd732f0 ("Move computation of dir_rename_count from
merge-ort to diffcore-rename", 2021-02-27), much of the logic for
computing directory renames moved into diffcore-rename.
directory-rename-detection.txt had claims that all of that logic was
found in merge-recursive.  Update the documentation.

Signed-off-by: Elijah Newren <[e-mail]>
---
 .../technical/directory-rename-detection.txt       | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

Comments

Junio C Hamano Aug. 4, 2021, 12:06 a.m. UTC | #1

"Elijah Newren via GitGitGadget" <[e-mail]> writes:

> diff --git a/Documentation/technical/directory-rename-detection.txt b/Documentation/technical/directory-rename-detection.txt
> index 49b83ef3cc4..029ee2cedc5 100644
> --- a/Documentation/technical/directory-rename-detection.txt
> +++ b/Documentation/technical/directory-rename-detection.txt
> @@ -2,9 +2,9 @@ Directory rename detection
>  ==========================
>  
>  Rename detection logic in diffcore-rename that checks for renames of
> -individual files is aggregated and analyzed in merge-recursive for cases
> -where combinations of renames indicate that a full directory has been
> -renamed.
> +individual files is also aggregated there and then analyzed in either
> +merge-ort or merge-recursive for cases where combinations of renames
> +indicate that a full directory has been renamed.
>  
>  Scope of abilities
>  ------------------
> @@ -88,9 +88,11 @@ directory rename detection support in:
>      Folks have requested in the past that `git diff` detect directory
>      renames and somehow simplify its output.  It is not clear whether this
>      would be desirable or how the output should be simplified, so this was
> -    simply not implemented.  Further, to implement this, directory rename
> -    detection logic would need to move from merge-recursive to
> -    diffcore-rename.
> +    simply not implemented.  Also, while diffcore-rename has most of the
> +    logic for detecting directory renames, some of the logic is still found
> +    within merge-ort and merge-recursive.  Fully supporting directory
> +    rename detection in diffs would require copying or moving the remaining
> +    bits of logic to the diff machinery.
>  
>    * am

Looks good.

Patch

diff --git a/Documentation/technical/directory-rename-detection.txt b/Documentation/technical/directory-rename-detection.txt
index 49b83ef3cc4..029ee2cedc5 100644
--- a/Documentation/technical/directory-rename-detection.txt
+++ b/Documentation/technical/directory-rename-detection.txt
@@ -2,9 +2,9 @@  Directory rename detection
 ==========================
 
 Rename detection logic in diffcore-rename that checks for renames of
-individual files is aggregated and analyzed in merge-recursive for cases
-where combinations of renames indicate that a full directory has been
-renamed.
+individual files is also aggregated there and then analyzed in either
+merge-ort or merge-recursive for cases where combinations of renames
+indicate that a full directory has been renamed.
 
 Scope of abilities
 ------------------
@@ -88,9 +88,11 @@  directory rename detection support in:
     Folks have requested in the past that `git diff` detect directory
     renames and somehow simplify its output.  It is not clear whether this
     would be desirable or how the output should be simplified, so this was
-    simply not implemented.  Further, to implement this, directory rename
-    detection logic would need to move from merge-recursive to
-    diffcore-rename.
+    simply not implemented.  Also, while diffcore-rename has most of the
+    logic for detecting directory renames, some of the logic is still found
+    within merge-ort and merge-recursive.  Fully supporting directory
+    rename detection in diffs would require copying or moving the remaining
+    bits of logic to the diff machinery.
 
   * am