feat: add Repository::workdir() as replacement for Repository::work_dir().

Keep the latter as deprecated though.

Author: Byron

gix/examples/clone.rs

@@ -27,11 +27,11 @@ fn main() -> anyhow::Result<()> {
 
     println!(
         "Checking out into {:?} ...",
-        prepare_checkout.repo().work_dir().expect("should be there")
+        prepare_checkout.repo().workdir().expect("should be there")
     );
 
     let (repo, _) = prepare_checkout.main_worktree(gix::progress::Discard, &gix::interrupt::IS_INTERRUPTED)?;
-    println!("Repo cloned into {:?}", repo.work_dir().expect("directory pre-created"));
+    println!("Repo cloned into {:?}", repo.workdir().expect("directory pre-created"));
 
     let remote = repo
         .find_default_remote(gix::remote::Direction::Fetch)

gix/examples/stats.rs

@@ -4,7 +4,7 @@ use gix::{prelude::ObjectIdExt, Reference};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut repo = gix::discover(".")?;
-    println!("Repo: {}", repo.work_dir().unwrap_or_else(|| repo.git_dir()).display());
+    println!("Repo: {}", repo.workdir().unwrap_or_else(|| repo.git_dir()).display());
     let mut max_parents = 0;
     let mut avg_parents = 0;
     repo.object_cache_size(32 * 1024);

gix/src/clone/access.rs

@@ -68,7 +68,7 @@ impl PrepareFetch {
 impl Drop for PrepareFetch {
     fn drop(&mut self) {
         if let Some(repo) = self.repo.take() {
-            std::fs::remove_dir_all(repo.work_dir().unwrap_or_else(|| repo.path())).ok();
+            std::fs::remove_dir_all(repo.workdir().unwrap_or_else(|| repo.path())).ok();
         }
     }
 }

gix/src/clone/checkout.rs

@@ -92,7 +92,7 @@ pub mod main_worktree {
                 .repo
                 .as_ref()
                 .expect("BUG: this method may only be called until it is successful");
-            let workdir = repo.work_dir().ok_or_else(|| Error::BareRepository {
+            let workdir = repo.workdir().ok_or_else(|| Error::BareRepository {
                 git_dir: repo.git_dir().to_owned(),
             })?;
 
@@ -173,7 +173,7 @@ impl PrepareCheckout {
 impl Drop for PrepareCheckout {
     fn drop(&mut self) {
         if let Some(repo) = self.repo.take() {
-            std::fs::remove_dir_all(repo.work_dir().unwrap_or_else(|| repo.path())).ok();
+            std::fs::remove_dir_all(repo.workdir().unwrap_or_else(|| repo.path())).ok();
         }
     }
 }

gix/src/config/cache/init.rs

@@ -303,7 +303,7 @@ impl crate::Repository {
     }
 
     fn apply_changed_values(&mut self) {
-        self.refs.write_reflog = util::reflog_or_default(self.config.reflog, self.work_dir().is_some());
+        self.refs.write_reflog = util::reflog_or_default(self.config.reflog, self.workdir().is_some());
         self.refs.namespace.clone_from(&self.config.refs_namespace);
     }
 }

gix/src/dirwalk/iter.rs

@@ -34,7 +34,7 @@ pub struct Outcome {
     /// The pathspecs used to guide the operation,
     pub pathspec: PathspecDetached,
     /// The root actually being used for the traversal, and useful to transform the paths returned for the user.
-    /// It's always within the [`work-dir`](Repository::work_dir).
+    /// It's always within the [`work-dir`](Repository::workdir).
     pub traversal_root: PathBuf,
     /// The actual result of the dirwalk.
     pub dirwalk: gix_dir::walk::Outcome,

gix/src/dirwalk/mod.rs

@@ -64,7 +64,7 @@ pub struct Outcome<'repo> {
     /// The pathspecs used to guide the operation,
     pub pathspec: Pathspec<'repo>,
     /// The root actually being used for the traversal, and useful to transform the paths returned for the user.
-    /// It's always within the [`work-dir`](crate::Repository::work_dir).
+    /// It's always within the [`work-dir`](crate::Repository::workdir).
     pub traversal_root: PathBuf,
     /// The actual result of the dirwalk.
     pub dirwalk: gix_dir::walk::Outcome,

gix/src/filter.rs

@@ -228,7 +228,7 @@ impl Pipeline<'_> {
 
         let rela_path_as_path = gix_path::from_bstr(rela_path);
         let repo = self.repo;
-        let worktree_dir = repo.work_dir().ok_or(Error::MissingWorktree)?;
+        let worktree_dir = repo.workdir().ok_or(Error::MissingWorktree)?;
         let path = worktree_dir.join(&rela_path_as_path);
         let md = match std::fs::symlink_metadata(&path) {
             Ok(md) => md,

gix/src/pathspec.rs

@@ -60,7 +60,7 @@ impl<'repo> Pathspec<'repo> {
             patterns,
             prefix,
             &gix_path::realpath_opts(
-                repo.work_dir().unwrap_or_else(|| repo.git_dir()),
+                repo.workdir().unwrap_or_else(|| repo.git_dir()),
                 repo.options.current_dir_or_empty(),
                 gix_path::realpath::MAX_SYMLINKS,
             )?,

gix/src/remote/connection/fetch/update_refs/mod.rs

@@ -444,7 +444,7 @@ fn insert_head(
     head: Option<crate::Head<'_>>,
     out: &mut BTreeMap<gix_ref::FullName, Vec<PathBuf>>,
 ) -> Result<(), update::Error> {
-    if let Some((head, wd)) = head.and_then(|head| head.repo.work_dir().map(|wd| (head, wd))) {
+    if let Some((head, wd)) = head.and_then(|head| head.repo.workdir().map(|wd| (head, wd))) {
         out.entry("HEAD".try_into().expect("valid"))
             .or_default()
             .push(wd.to_owned());