Merge branch 'worktree-organization'

Author: Byron

Cargo.lock

@@ -235,6 +235,8 @@ members = [
     "gix-index",
     "gix-bitmap",
     "gix-worktree",
+    "gix-worktree-state",
+    "gix-status",
     "gix-revision",
     "gix-packetline",
     "gix-packetline-blocking",

Cargo.toml

@@ -95,6 +95,8 @@ is usable to some extent.
   * [gix-worktree-stream](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-worktree-stream)
   * [gix-archive](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-archive)
   * [gix-submodule](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-submodule)
+  * [gix-status](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-status)
+  * [gix-worktree-state](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-worktree-state)
   * `gitoxide-core`
 * **very early**  _(possibly without any documentation and many rough edges)_
   * [gix-date](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-date)

README.md

@@ -453,28 +453,36 @@ Make it the best-performing implementation and the most convenient one.
 ### gix-glob
 * [x] parse pattern
 * [x] a type for pattern matching of paths and non-paths, optionally case-insensitively.
-
-### gix-worktree
+ 
+### gix-status
+* [x] differences between index and worktree to turn index into worktree
+* [ ] differences between tree and index to turn tree into index
+* [ ] untracked files
+* [ ] fast answer to 'is it dirty'.
+* 
+### gix-worktree-state
 * handle the working **tree/checkout**
-  - [x] checkout an index of files, executables and symlinks just as fast as git
-     - [x] forbid symlinks in directories
-     - [ ] handle submodules
-     - [ ] handle sparse directories
-     - [ ] handle sparse index
-     - [x] linear scaling with multi-threading up to IO saturation
-  - supported attributes to affect working tree and index contents
-     - [ ] eol
-     - [ ] working-tree-encoding
-     - …more
-  - **filtering** 
-     - [ ] `text`
-     - [ ] `ident`
-     - [ ] filter processes
-     - [ ] single-invocation clean/smudge filters
-* manage multiple worktrees
+    - [x] checkout an index of files, executables and symlinks just as fast as git
+        - [x] forbid symlinks in directories
+        - [ ] handle submodules
+        - [ ] handle sparse directories
+        - [ ] handle sparse index
+        - [x] linear scaling with multi-threading up to IO saturation
+    - supported attributes to affect working tree and index contents
+        - [x] eol
+        - [x] working-tree-encoding
+        - …more
+    - **filtering**
+        - [x] `text`
+        - [x] `ident`
+        - [x] filter processes
+        - [x] single-invocation clean/smudge filters
 * access to per-path information, like `.gitignore` and `.gitattributes` in a manner well suited for efficient lookups
-  * [x] _exclude_ information
-  * [ ] attributes
+    * [x] _exclude_ information
+    * [x] attributes
+
+### gix-worktree
+* [x] A stack to to efficiently generate attribute lists for matching paths against.
 
 ### gix-revision
 * [x] `describe()` (similar to `git name-rev`)

crate-status.md

@@ -0,0 +1,3 @@
+╔════════════════╗
+║ gix-submodule  ║
+╚════════════════╝

etc/gix-components.monopic

@@ -101,8 +101,8 @@ pub fn spawn_tree_delta_threads<'scope>(
                             repo.index_or_load_from_head().map_err(Into::into).and_then(|index| {
                                 repo.attributes(
                                     &index,
-                                    gix::worktree::cache::state::attributes::Source::IdMapping,
-                                    gix::worktree::cache::state::ignore::Source::IdMapping,
+                                    gix::worktree::stack::state::attributes::Source::IdMapping,
+                                    gix::worktree::stack::state::ignore::Source::IdMapping,
                                     None,
                                 )
                                 .map_err(Into::into)

etc/gix-components.txt

@@ -4,7 +4,7 @@ use std::{
 };
 
 use anyhow::bail;
-use gix::{odb::FindExt, worktree::checkout, Progress};
+use gix::{odb::FindExt, worktree::state::checkout, Progress};
 
 use crate::{
     index,
@@ -55,7 +55,7 @@ pub fn checkout_exclusive(
         progress.info(format!("Skipping {num_skipped} DIR/SYMLINK/COMMIT entries"));
     }
 
-    let opts = gix::worktree::checkout::Options {
+    let opts = gix::worktree::state::checkout::Options {
         fs: gix::fs::Capabilities::probe(dest_directory),
 
         destination_is_initially_empty: true,
@@ -86,7 +86,7 @@ pub fn checkout_exclusive(
         delayed_paths_unknown,
         delayed_paths_unprocessed,
     } = match repo {
-        Some(repo) => gix::worktree::checkout(
+        Some(repo) => gix::worktree::state::checkout(
             &mut index,
             dest_directory,
             {
@@ -109,7 +109,7 @@ pub fn checkout_exclusive(
             should_interrupt,
             opts,
         ),
-        None => gix::worktree::checkout(
+        None => gix::worktree::state::checkout(
             &mut index,
             dest_directory,
             |_, buf| {

gitoxide-core/src/hours/core.rs

@@ -89,16 +89,16 @@ pub(crate) mod function {
 
 pub(crate) fn attributes_cache(
     repo: &gix::Repository,
-) -> anyhow::Result<(gix::worktree::Cache, IndexPersistedOrInMemory)> {
+) -> anyhow::Result<(gix::worktree::Stack, IndexPersistedOrInMemory)> {
     let index = repo.index_or_load_from_head()?;
     let cache = repo.attributes(
         &index,
         if repo.is_bare() {
-            gix::worktree::cache::state::attributes::Source::IdMapping
+            gix::worktree::stack::state::attributes::Source::IdMapping
         } else {
-            gix::worktree::cache::state::attributes::Source::WorktreeThenIdMapping
+            gix::worktree::stack::state::attributes::Source::WorktreeThenIdMapping
         },
-        gix::worktree::cache::state::ignore::Source::IdMapping,
+        gix::worktree::stack::state::ignore::Source::IdMapping,
         None,
     )?;
     Ok((cache, index))

gitoxide-core/src/index/checkout.rs

@@ -111,7 +111,7 @@ pub(crate) mod function {
             }
         };
 
-        if let Some(gix::worktree::checkout::Outcome { collisions, errors, .. }) = outcome {
+        if let Some(gix::worktree::state::checkout::Outcome { collisions, errors, .. }) = outcome {
             if !(collisions.is_empty() && errors.is_empty()) {
                 let mut messages = Vec::new();
                 if !errors.is_empty() {