diff --git a/gitoxide-core/src/lib.rs b/gitoxide-core/src/lib.rs
index 9ff7ab73760..3b0237d1e52 100644
--- a/gitoxide-core/src/lib.rs
+++ b/gitoxide-core/src/lib.rs
@@ -30,6 +30,7 @@
#![deny(rust_2018_idioms)]
#![forbid(unsafe_code)]
+use anyhow::bail;
use std::str::FromStr;
#[derive(Debug, Eq, PartialEq, Hash, Clone, Copy)]
@@ -82,6 +83,51 @@ pub mod repository;
mod discover;
pub use discover::discover;
+pub fn env(mut out: impl std::io::Write, format: OutputFormat) -> anyhow::Result<()> {
+ if format != OutputFormat::Human {
+ bail!("JSON output isn't supported");
+ };
+
+ let width = 15;
+ writeln!(
+ out,
+ "{field:>width$}: {}",
+ std::path::Path::new(gix::path::env::shell()).display(),
+ field = "shell",
+ )?;
+ writeln!(
+ out,
+ "{field:>width$}: {:?}",
+ gix::path::env::installation_config_prefix(),
+ field = "config prefix",
+ )?;
+ writeln!(
+ out,
+ "{field:>width$}: {:?}",
+ gix::path::env::installation_config(),
+ field = "config",
+ )?;
+ writeln!(
+ out,
+ "{field:>width$}: {}",
+ gix::path::env::exe_invocation().display(),
+ field = "git exe",
+ )?;
+ writeln!(
+ out,
+ "{field:>width$}: {:?}",
+ gix::path::env::system_prefix(),
+ field = "system prefix",
+ )?;
+ writeln!(
+ out,
+ "{field:>width$}: {:?}",
+ gix::path::env::core_dir(),
+ field = "core dir",
+ )?;
+ Ok(())
+}
+
#[cfg(all(feature = "async-client", feature = "blocking-client"))]
compile_error!("Cannot set both 'blocking-client' and 'async-client' features as they are mutually exclusive");
diff --git a/gix-path/src/env/mod.rs b/gix-path/src/env/mod.rs
index cdc092dcb25..71188fb2a17 100644
--- a/gix-path/src/env/mod.rs
+++ b/gix-path/src/env/mod.rs
@@ -1,4 +1,4 @@
-use std::ffi::OsString;
+use std::ffi::{OsStr, OsString};
use std::path::{Path, PathBuf};
use bstr::{BString, ByteSlice};
@@ -28,21 +28,25 @@ pub fn installation_config_prefix() -> Option<&'static Path> {
installation_config().map(git::config_to_base_path)
}
-/// Return the shell that Git would prefer as login shell, the shell to execute Git commands from.
+/// Return the shell that Git would use, the shell to execute commands from.
///
-/// On Windows, this is the `bash.exe` bundled with it, and on Unix it's the shell specified by `SHELL`,
-/// or `None` if it is truly unspecified.
-pub fn login_shell() -> Option<&'static Path> {
- static PATH: Lazy<Option<PathBuf>> = Lazy::new(|| {
+/// On Windows, this is the full path to `sh.exe` bundled with Git, and on
+/// Unix it's `/bin/sh` as posix compatible shell.
+/// If the bundled shell on Windows cannot be found, `sh` is returned as the name of a shell
+/// as it could possibly be found in `PATH`.
+/// Note that the returned path might not be a path on disk.
+pub fn shell() -> &'static OsStr {
+ static PATH: Lazy<OsString> = Lazy::new(|| {
if cfg!(windows) {
- installation_config_prefix()
- .and_then(|p| p.parent())
- .map(|p| p.join("usr").join("bin").join("bash.exe"))
+ core_dir()
+ .and_then(|p| p.ancestors().nth(3)) // Skip something like mingw64/libexec/git-core.
+ .map(|p| p.join("usr").join("bin").join("sh.exe"))
+ .map_or_else(|| OsString::from("sh"), Into::into)
} else {
- std::env::var_os("SHELL").map(PathBuf::from)
+ "/bin/sh".into()
}
});
- PATH.as_deref()
+ PATH.as_ref()
}
/// Return the name of the Git executable to invoke it.
@@ -102,6 +106,36 @@ pub fn xdg_config(file: &str, env_var: &mut dyn FnMut(&str) -> Option<OsString>)
})
}
+static GIT_CORE_DIR: Lazy<Option<PathBuf>> = Lazy::new(|| {
+ let mut cmd = std::process::Command::new(exe_invocation());
+
+ #[cfg(windows)]
+ {
+ use std::os::windows::process::CommandExt;
+ const CREATE_NO_WINDOW: u32 = 0x08000000;
+ cmd.creation_flags(CREATE_NO_WINDOW);
+ }
+ let output = cmd.arg("--exec-path").output().ok()?;
+
+ if !output.status.success() {
+ return None;
+ }
+
+ BString::new(output.stdout)
+ .strip_suffix(b"\n")?
+ .to_path()
+ .ok()?
+ .to_owned()
+ .into()
+});
+
+/// Return the directory obtained by calling `git --exec-path`.
+///
+/// Returns `None` if Git could not be found or if it returned an error.
+pub fn core_dir() -> Option<&'static Path> {
+ GIT_CORE_DIR.as_deref()
+}
+
/// Returns the platform dependent system prefix or `None` if it cannot be found (right now only on windows).
///
/// ### Performance
@@ -125,22 +159,7 @@ pub fn system_prefix() -> Option<&'static Path> {
}
}
- let mut cmd = std::process::Command::new(exe_invocation());
- #[cfg(windows)]
- {
- use std::os::windows::process::CommandExt;
- const CREATE_NO_WINDOW: u32 = 0x08000000;
- cmd.creation_flags(CREATE_NO_WINDOW);
- }
- cmd.arg("--exec-path").stderr(std::process::Stdio::null());
- gix_trace::debug!(cmd = ?cmd, "invoking git to get system prefix/exec path");
- let path = cmd.output().ok()?.stdout;
- let path = BString::new(path)
- .trim_with(|b| b.is_ascii_whitespace())
- .to_path()
- .ok()?
- .to_owned();
-
+ let path = GIT_CORE_DIR.as_deref()?;
let one_past_prefix = path.components().enumerate().find_map(|(idx, c)| {
matches!(c,std::path::Component::Normal(name) if name.to_str() == Some("libexec")).then_some(idx)
})?;
diff --git a/gix-path/tests/path/env.rs b/gix-path/tests/path/env.rs
index d2c4f9fd265..28f23f9cb7b 100644
--- a/gix-path/tests/path/env.rs
+++ b/gix-path/tests/path/env.rs
@@ -8,13 +8,11 @@ fn exe_invocation() {
}
#[test]
-fn login_shell() {
- // On CI, the $SHELL variable isn't necessarily set. Maybe other ways to get the login shell should be used then.
- if !gix_testtools::is_ci::cached() {
- assert!(gix_path::env::login_shell()
- .expect("There should always be the notion of a shell used by git")
- .exists());
- }
+fn shell() {
+ assert!(
+ std::path::Path::new(gix_path::env::shell()).exists(),
+ "On CI and on Unix we'd expect a full path to the shell that exists on disk"
+ );
}
#[test]
@@ -26,6 +24,16 @@ fn installation_config() {
);
}
+#[test]
+fn core_dir() {
+ assert!(
+ gix_path::env::core_dir()
+ .expect("Git is always in PATH when we run tests")
+ .is_dir(),
+ "The core directory is a valid directory"
+ );
+}
+
#[test]
fn system_prefix() {
assert_ne!(
diff --git a/src/plumbing/main.rs b/src/plumbing/main.rs
index 625f9733268..577b23208d6 100644
--- a/src/plumbing/main.rs
+++ b/src/plumbing/main.rs
@@ -146,6 +146,15 @@ pub fn main() -> Result<()> {
}
match cmd {
+ Subcommands::Env => prepare_and_run(
+ "env",
+ trace,
+ verbose,
+ progress,
+ progress_keep_open,
+ None,
+ move |_progress, out, _err| core::env(out, format),
+ ),
Subcommands::Merge(merge::Platform { cmd }) => match cmd {
merge::SubCommands::File {
resolve_with,
diff --git a/src/plumbing/options/mod.rs b/src/plumbing/options/mod.rs
index a1f37b08e13..5439b600f42 100644
--- a/src/plumbing/options/mod.rs
+++ b/src/plumbing/options/mod.rs
@@ -145,6 +145,7 @@ pub enum Subcommands {
Corpus(corpus::Platform),
MergeBase(merge_base::Command),
Merge(merge::Platform),
+ Env,
Diff(diff::Platform),
Log(log::Platform),
Worktree(worktree::Platform),