Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
6ac7dbe
refactor (#470)
Byron Sep 19, 2022
a938fe4
refactor (#470)
Byron Sep 19, 2022
c857b9b
diff platform for basic diff configuration (#470)
Byron Sep 19, 2022
e51f3cd
break through API surface and sketch delegate calling user-provided f…
Byron Sep 19, 2022
5be96b3
allow user callbacks to have any error (#470)
Byron Sep 19, 2022
a9056fd
first test for simple file modification detection (#470)
Byron Sep 19, 2022
7fd9b0e
Provisions for tracking the location of a change. (#470)
Byron Sep 19, 2022
88c4a57
Support for file-name tracking (#470)
Byron Sep 19, 2022
d04807b
improved usability of the `Action` enum (#470)
Byron Sep 19, 2022
9b7aaa0
fix docs (#470)
Byron Sep 19, 2022
90b9c90
refactor (#470)
Byron Sep 19, 2022
9d01fb4
refactor (#470)
Byron Sep 19, 2022
ae38660
fix: rev-spec parsing can now handle the empty tree as full hex hash.…
Byron Sep 19, 2022
64bbb3d
Support for Path tracking (#470)
Byron Sep 19, 2022
0670468
performance note (#470)
Byron Sep 19, 2022
963055b
Slightly improved docs for traversal docs. (#470)
Byron Sep 19, 2022
e164856
feat: forward line-diffing capabilities curtesy of the `similar` crat…
Byron Sep 19, 2022
8c2e5c6
feat: Once a change is obtained, it's easy to obtain changes line by …
Byron Sep 19, 2022
6b2af57
feat: Make it possible to access the current commits buffer during co…
Byron Sep 19, 2022
1027be9
feat: `interrupt::Iter` now allows accessing the inner iterator witho…
Byron Sep 19, 2022
28c4cae
feat: `ein tool hours --stat` to collect additional statistics per au…
Byron Sep 19, 2022
5878ad1
a little more complexity for diff tests (#470)
Byron Sep 19, 2022
523418f
feat: add support for `wasi` (#470)
Byron Sep 20, 2022
15a18e4
simplify looking up entries by path (#470)
Byron Sep 20, 2022
79c2255
rename!: `Tree::lookup_path()` -> `Tree::lookup_entry()`. (#470)
Byron Sep 20, 2022
5ec714f
adapt to changes in `git-repository` (#470)
Byron Sep 20, 2022
b285097
Add note on why we consume the tree for looking up an entry. (#470)
Byron Sep 20, 2022
77ff8ae
thanks clippy
Byron Sep 20, 2022
593f57b
fix docs (#470)
Byron Sep 20, 2022
0ac4a2c
upgrade to prodash 20.1 for `Progress::counter()` feature (#470)
Byron Sep 20, 2022
0871a96
feat: `Object::peel_to_tree()` as convenience method. (#470)
Byron Sep 20, 2022
0947c70
First attempt to get progress information from stat worker. (#470)
Byron Sep 20, 2022
67ec2c7
working progress printing (#470)
Byron Sep 20, 2022
b8f2f8b
feat: `ein tool hours -s` shows statistics about files added/removed/…
Byron Sep 20, 2022
ffd4f0f
avoid binary search if there is nothing to find (#470)
Byron Sep 20, 2022
3c7c9a7
change: `ein tool hours -s` was split into `-f|--file-stats` and `-l|…
Byron Sep 20, 2022
0614318
show discovered file chnages in real-time (#470)
Byron Sep 20, 2022
84eb777
collect changes lines as well (#470)
Byron Sep 20, 2022
cb53324
make stat extractions interruptable (#470)
Byron Sep 20, 2022
e3e3211
refactor (#470)
Byron Sep 20, 2022
e27b65a
replace `flume` with `crossbeam-channel` as it's already in the depen…
Byron Sep 20, 2022
2a3c5b0
only diff files that are probably not a binary file (as per extension…
Byron Sep 20, 2022
bf63a13
percentages for files and lines added (#470)
Byron Sep 20, 2022
47e2370
Some tests to pin the new statistical capabilities (#470)
Byron Sep 20, 2022
caa7a1b
update changelogs prior to release (#470)
Byron Sep 20, 2022
29a043b
Release git-hash v0.9.10, git-features v0.22.5, git-date v0.2.0, git-…
Byron Sep 20, 2022
9a8369d
fix dependency declaration (#470)
Byron Sep 20, 2022
f5c36d8
Release git-command v0.1.0, git-prompt v0.1.0, git-url v0.9.0, git-cr…
Byron Sep 20, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Slightly improved docs for traversal docs. (#470)
  • Loading branch information
Byron committed Sep 19, 2022
commit 963055b45643fb48460671959b10dc12658bb5d4
11 changes: 7 additions & 4 deletions git-repository/src/object/tree/traverse.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ impl<'repo> Tree<'repo> {
/// An intermediate object to start traversing the parent tree from.
pub struct Platform<'a, 'repo> {
root: &'a Tree<'repo>,
#[allow(missing_docs)] // TODO
/// Provides easy access to presets for common breadth-first traversal.
pub breadthfirst: BreadthFirstPresets<'a, 'repo>,
}

#[allow(missing_docs)] // TODO
/// Presets for common choices in breadth-first traversal.
#[derive(Copy, Clone)]
pub struct BreadthFirstPresets<'a, 'repo> {
root: &'a Tree<'repo>,
Expand All @@ -39,8 +39,11 @@ impl<'a, 'repo> BreadthFirstPresets<'a, 'repo> {
}

impl<'a, 'repo> Platform<'a, 'repo> {
/// Start a breadth-first traversal with a delegate, note that it's not sorted.
/// TODO: more docs or links to git-traverse
/// Start a breadth-first traversal using `delegate`, for which a [`Recorder`][git_traverse::tree::Recorder] can be used to get started.
///
/// # Note
///
/// Results are not sorted.
pub fn breadthfirst<V>(&self, delegate: &mut V) -> Result<(), git_traverse::tree::breadthfirst::Error>
where
V: git_traverse::tree::Visit,
Expand Down