From 3c8e3c1e88d36657d4e6eeaf0819be7fd9341ae1 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Sat, 24 Jun 2023 18:55:05 +0200 Subject: [PATCH] doc: make clear what can happen if rewrite-tracking isn't disabled if it is not desired. Triggered by this `onefetch` PR: https://github.com/o2sh/onefetch/pull/1093 --- gix/src/object/tree/diff/mod.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/gix/src/object/tree/diff/mod.rs b/gix/src/object/tree/diff/mod.rs index 447eeaa84c4..5f7a041e4df 100644 --- a/gix/src/object/tree/diff/mod.rs +++ b/gix/src/object/tree/diff/mod.rs @@ -34,6 +34,10 @@ impl<'repo> Tree<'repo> { /// /// It's highly recommended to set an object cache to avoid extracting the same object multiple times. /// By default, similar to `git diff`, rename tracking will be enabled if it is not configured. + /// + /// Note that if a clone with `--filter=blob=none` was created, rename tracking may fail as it might + /// try to access blobs to compute a similarity metric. Thus, it's more compatible to turn rewrite tracking off + /// using [`Platform::track_rewrites()`]. #[allow(clippy::result_large_err)] pub fn changes<'a>(&'a self) -> Result, rewrites::Error> { Ok(Platform {