File tree 1 file changed +16
-3
lines changed 1 file changed +16
-3
lines changed Original file line number Diff line number Diff line change 2
2
//! of the repository state, like comparisons between…
3
3
//!
4
4
//! * index and working tree
5
- //! * index and tree
6
- //! * find untracked files
5
+ //! * *tree and index*
7
6
//!
8
- //! While also being able to check check if the working tree is dirty, quickly.
7
+ //! …while also being able to check if the working tree is dirty, quickly, by instructing the operation to stop once the first
8
+ //! change was found.
9
+ //!
10
+ //! ### Tree-Index Status
11
+ //!
12
+ //! This status is not actually implemented here as it's not implemented directly. Instead, one creates an Index from a tree
13
+ //! and then diffs two indices with `gix_diff::index(index_from_tree, usually_dot_git_index)`. This adds about 15% to the runtime
14
+ //! and comes at the cost of another index in memory.
15
+ //! Once there are generators implementing depth-first tree iteration should become trivial, but for now it's very hard if one
16
+ //! wants to return referenced state of the iterator (which is not possible).
17
+ //!
18
+ //! ### Difference to `gix-diff`
19
+ //!
20
+ //! Technically, `status` is just another form of diff between different kind of sides, i.e. an index and a working tree.
21
+ //! This is the difference to `gix-diff`, which compares only similar items.
9
22
//!
10
23
//! ### Feature Flags
11
24
#![ cfg_attr(
You can’t perform that action at this time.
0 commit comments