feat: Add gix::discover_with_environment_overrides()

Author: cruessler

gix/src/discover.rs

@@ -3,7 +3,7 @@ use std::path::Path;
 
 pub use gix_discover::*;
 
-use crate::{bstr::BString, ThreadSafeRepository};
+use crate::{bstr::BString, Repository, ThreadSafeRepository};
 
 /// The error returned by [`crate::discover()`].
 #[derive(Debug, thiserror::Error)]
@@ -49,6 +49,8 @@ impl ThreadSafeRepository {
     /// Try to open a git repository directly from the environment.
     /// If that fails, discover upwards from `directory` until one is found,
     /// while applying discovery options from the environment.
+    ///
+    /// For more, see [`ThreadSafeRepository::discover_with_environment_overrides_opts()`].
     pub fn discover_with_environment_overrides(directory: impl AsRef<Path>) -> Result<Self, Error> {
         Self::discover_with_environment_overrides_opts(directory, Default::default(), Default::default())
     }

gix/src/lib.rs

@@ -29,7 +29,7 @@
 //!
 //! By default, the [`Repository`] isn't `Sync` and thus can't be used in certain contexts which require the `Sync` trait.
 //!
-//! To help with this, convert it with [`.into_sync()`][Repository::into_sync()] into a [`ThreadSafeRepository`].
+//! To help with this, convert it with [`Repository::into_sync()`] into a [`ThreadSafeRepository`].
 //!
 //! ### Object-Access Performance
 //!
@@ -41,7 +41,7 @@
 //! On miss, the object is looked up and if a pack is hit, there is a small fixed-size cache for delta-base objects.
 //!
 //! In scenarios where the same objects are accessed multiple times, the object cache can be useful and is to be configured specifically
-//! using the [`object_cache_size(…)`][crate::Repository::object_cache_size()] method.
+//! using the [`Repository::object_cache_size()`] method.
 //!
 //! Use the `cache-efficiency-debug` cargo feature to learn how efficient the cache actually is - it's easy to end up with lowered
 //! performance if the cache is not hit in 50% of the time.
@@ -207,7 +207,10 @@ pub mod diff;
 #[cfg(feature = "merge")]
 pub mod merge;
 
-/// See [`ThreadSafeRepository::discover()`], but returns a [`Repository`] instead.
+/// Try to open a git repository in `directory` and search upwards through its parents until one is found,
+/// using default trust options which matters in case the found repository isn't owned by the current user.
+///
+/// For details, see [`ThreadSafeRepository::discover()`].
 ///
 /// # Note
 ///
@@ -222,7 +225,19 @@ pub fn discover(directory: impl AsRef<std::path::Path>) -> Result<Repository, di
     ThreadSafeRepository::discover(directory).map(Into::into)
 }
 
-/// See [`ThreadSafeRepository::open_with_environment_overrides()`], but returns a [`Repository`] instead.
+/// Try to discover a git repository directly from the environment.
+///
+/// For details, see [`ThreadSafeRepository::discover_with_environment_overrides_opts()`].
+#[allow(clippy::result_large_err)]
+pub fn discover_with_environment_overrides(
+    directory: impl AsRef<std::path::Path>,
+) -> Result<Repository, discover::Error> {
+    ThreadSafeRepository::discover_with_environment_overrides(directory).map(Into::into)
+}
+
+/// Try to open a git repository directly from the environment.
+///
+/// See [`ThreadSafeRepository::open_with_environment_overrides()`].
 #[allow(clippy::result_large_err)]
 pub fn open_with_environment_overrides(directory: impl Into<std::path::PathBuf>) -> Result<Repository, open::Error> {
     ThreadSafeRepository::open_with_environment_overrides(directory, Default::default()).map(Into::into)

gix/src/types.rs

@@ -145,7 +145,9 @@ pub struct Reference<'r> {
 
 /// A thread-local handle to interact with a repository from a single thread.
 ///
-/// It is `Send` but **not** `Sync` - for the latter you can convert it `to_sync()`.
+/// It is `Send`, but **not** `Sync` - for the latter you can convert it using
+/// [`Repository::into_sync()`].
+///
 /// Note that it clones itself so that it is empty, requiring the user to configure each clone separately, specifically
 /// and explicitly. This is to have the fastest-possible default configuration available by default, but allow
 /// those who experiment with workloads to get speed boosts of 2x or more.