Skip to content

Commit 3c8e3c1

Browse files
committed
doc: make clear what can happen if rewrite-tracking isn't disabled if it is not desired.
Triggered by this `onefetch` PR: o2sh/onefetch#1093
1 parent 6906e0d commit 3c8e3c1

File tree

1 file changed

+4
-0
lines changed
  • gix/src/object/tree/diff

1 file changed

+4
-0
lines changed

gix/src/object/tree/diff/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ impl<'repo> Tree<'repo> {
3434
///
3535
/// It's highly recommended to set an object cache to avoid extracting the same object multiple times.
3636
/// By default, similar to `git diff`, rename tracking will be enabled if it is not configured.
37+
///
38+
/// Note that if a clone with `--filter=blob=none` was created, rename tracking may fail as it might
39+
/// try to access blobs to compute a similarity metric. Thus, it's more compatible to turn rewrite tracking off
40+
/// using [`Platform::track_rewrites()`].
3741
#[allow(clippy::result_large_err)]
3842
pub fn changes<'a>(&'a self) -> Result<Platform<'a, 'repo>, rewrites::Error> {
3943
Ok(Platform {

0 commit comments

Comments
 (0)