Skip to content

Commit 991c939

Browse files
committed
doc: Update "cmp" links in tree::function::diff
This updates the "git_cmp_c" and "git_cmp_rs" links in the `gix_diff::tree::function::diff` documentation comment. - The significant change is to the "git_cmp_rs" link (the second link), which accounts for how files have renamed and how code has been moved, and also changed in #849 to fix issue #848. This hyperlink change completes the third task listed in #1627. - The other change is to update the "git_cmp_c" link at the same time. That code has not changed, and this is just referring to a later commit (the current tip of the master branch in git/git). The reason to also do this change is to make it easier to verify, both now and for anyone reading the documentation, that that link remains current.
1 parent 795962b commit 991c939

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

gix-diff/src/tree/function.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ use crate::tree::{visit::Change, Error, State, TreeInfoTuple, Visit};
2323
/// * cycle checking is not performed, but can be performed in the delegate which can return
2424
/// [`tree::visit::Action::Cancel`](crate::tree::visit::Action::Cancel) to stop the traversal.
2525
///
26-
/// [git_cmp_c]: https://github.com/git/git/blob/311531c9de557d25ac087c1637818bd2aad6eb3a/tree-diff.c#L49:L65
27-
/// [git_cmp_rs]: https://github.com/GitoxideLabs/gitoxide/blob/a4d5f99c8dc99bf814790928a3bf9649cd99486b/gix-object/src/mutable/tree.rs#L52-L55
26+
/// [git_cmp_c]: https://github.com/git/git/blob/ef8ce8f3d4344fd3af049c17eeba5cd20d98b69f/tree-diff.c#L72-L88
27+
/// [git_cmp_rs]: https://github.com/GitoxideLabs/gitoxide/blob/795962b107d86f58b1f7c75006da256d19cc80ad/gix-object/src/tree/mod.rs#L263-L273
2828
#[doc(alias = "diff_tree_to_tree", alias = "git2")]
2929
pub fn diff<StateMut>(
3030
lhs: TreeRefIter<'_>,

0 commit comments

Comments
 (0)