Merge branch 'match_ceiling_dir_or_error'

Byron · Dec 18, 2023 · cda5b51 · cda5b51
2 parents f7adf97 + 2e04403
commit cda5b51
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/gix-discover/src/upwards/types.rs b/gix-discover/src/upwards/types.rs
@@ -87,16 +87,12 @@ impl Options<'_> {
     ///
     /// Note that `GIT_DISCOVERY_ACROSS_FILESYSTEM` for `cross_fs` is **not** read,
     /// as it requires parsing of `git-config` style boolean values.
-    ///
-    /// In addition, this function disables `match_ceiling_dir_or_error` to allow
-    /// discovery if an outside environment variable sets non-matching ceiling directories.
     // TODO: test
     pub fn apply_environment(mut self) -> Self {
         let name = "GIT_CEILING_DIRECTORIES";
         if let Some(ceiling_dirs) = env::var_os(name) {
             self.ceiling_dirs = parse_ceiling_dirs(&ceiling_dirs);
         }
-        self.match_ceiling_dir_or_error = false;
         self
     }
 }

diff --git a/gix/src/discover.rs b/gix/src/discover.rs
@@ -63,6 +63,12 @@ impl ThreadSafeRepository {
     ///
     /// Finally, use the `trust_map` to determine which of our own repository options to use
     /// based on the trust level of the effective repository directory.
+    ///
+    /// ### Note
+    ///
+    /// Consider to set [`match_ceiling_dir_or_error = false`](gix_discover::upwards::Options::match_ceiling_dir_or_error)
+    /// to allow discovery if an outside environment variable sets non-matching ceiling directories for greater
+    /// compatibility with Git.
     #[momo]
     pub fn discover_with_environment_overrides_opts(
         directory: impl AsRef<Path>,