Skip to content

Commit

Permalink
doc: make clear what can happen if rewrite-tracking isn't disabled if…
Browse files Browse the repository at this point in the history
… it is not desired.

Triggered by this `onefetch` PR: o2sh/onefetch#1093
  • Loading branch information
Byron committed Jun 24, 2023
1 parent 6906e0d commit 3c8e3c1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions gix/src/object/tree/diff/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<Platform<'a, 'repo>, rewrites::Error> {
Ok(Platform {
Expand Down

0 comments on commit 3c8e3c1

Please sign in to comment.