From 09b34c9a665b4efd175c76a1ee1eca2f1f4897a4 Mon Sep 17 00:00:00 2001 From: Christopher McClellan Date: Mon, 29 Sep 2025 11:02:22 -0400 Subject: [PATCH] Update README note about ssh feature According to the Cargo.toml file, the ssh feature is not enabled by default. https://github.com/rust-lang/git2-rs/blob/d58c7ce8f9dfd10d25389791a54fe54e7bfd3b6f/Cargo.toml#L37 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bbbeb54820..516a087a6e 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ To skip tests on a simple commit or doc-fixes, use `git commit --no-verify`. ## Building on macOS 10.10+ -If the `ssh` feature is enabled (and it is by default) then this library depends +If the `ssh` feature is enabled then this library depends on libssh2 which depends on OpenSSL. To get OpenSSL working follow the [`openssl` crate's instructions](https://github.com/sfackler/rust-openssl/blob/master/openssl/src/lib.rs#L31).