summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2015-03-19 14:26:07 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2015-04-23 17:43:44 +0200
commit85247df0844501e8017f54bcbccfd3e72bb6c7c1 (patch)
treed53bd90d8bda57f250d7d850c3ac69feb58bf660
parentb7e1c81d1bb779bf97a209f239388d1a1cd25509 (diff)
downloadlibgit2-85247df0844501e8017f54bcbccfd3e72bb6c7c1.tar.gz
Update THREADING and CHANGELOG with SecureTransport details
-rw-r--r--CHANGELOG.md3
-rw-r--r--THREADING.md18
2 files changed, 17 insertions, 4 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 12c60532c..c97a18b50 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -31,6 +31,9 @@ v0.22 + 1
* `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
commit with unstaged changes.
+* On Mac OS X, we now use SecureTransport to provide the cryptographic
+support for HTTPS connections insead of OpenSSL.
+
### API additions
* The `git_merge_options` gained a `file_flags` member.
diff --git a/THREADING.md b/THREADING.md
index c9bee5184..cf7ac1ff0 100644
--- a/THREADING.md
+++ b/THREADING.md
@@ -41,12 +41,22 @@ both of which are thread-safe. You do not need to do anything special.
When using libssh2 which itself uses WinCNG, there are no special
steps necessary. If you are using a MinGW or similar environment where
-libssh2 uses OpenSSL or libgcrypt, then the non-Windows case affects
+libssh2 uses OpenSSL or libgcrypt, then the general case affects
you.
-Non-Windows
+On Mac OS X
-----------
+On OS X, the library makes use of CommonCrypto and SecureTransport for
+cryptographic support. These are thread-safe and you do not need to do
+anything special.
+
+Note that libssh2 may still use OpenSSL itself. In that case, the
+general case still affects you if you use ssh.
+
+General Case
+------------
+
On the rest of the platforms, libgit2 uses OpenSSL to be able to use
HTTPS as a transport. This library is made to be thread-implementation
agnostic, and the users of the library must set which locking function
@@ -71,8 +81,8 @@ See the
[OpenSSL documentation](https://www.openssl.org/docs/crypto/threads.html)
on threading for more details.
-Be also aware that libgit2 may not always link against OpenSSL in the
-future if there are alternatives provided by the system.
+Be also aware that libgit2 does not always link against OpenSSL
+if there are alternatives provided by the system.
libssh2 may be linked against OpenSSL or libgcrypt. If it uses
OpenSSL, you only need to set up threading for OpenSSL once and the