diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-12 08:29:43 +0100 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-12 15:46:57 +0100 |
| commit | 263b1d6ed97d56608f9a358fa0bfe9e66c968f36 (patch) | |
| tree | 1a12b0651cb6b194b8cef8615054c24e0cfbf6a0 /include | |
| parent | 4eb97ef3bf18403fbce351ae4cac673655d2886a (diff) | |
| download | libgit2-263b1d6ed97d56608f9a358fa0bfe9e66c968f36.tar.gz | |
Make the OpenSSL locking function warnings more severe
Our git_openssl_set_locking() would ideally not exist. Make it clearer
that we provide it as a last resort and you should prefer anything else.
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2.h | 1 | ||||
| -rw-r--r-- | include/git2/sys/openssl.h (renamed from include/git2/threads.h) | 20 |
2 files changed, 9 insertions, 12 deletions
diff --git a/include/git2.h b/include/git2.h index b36bb5365..cf6b5cb89 100644 --- a/include/git2.h +++ b/include/git2.h @@ -57,7 +57,6 @@ #include "git2/status.h" #include "git2/submodule.h" #include "git2/tag.h" -#include "git2/threads.h" #include "git2/transport.h" #include "git2/tree.h" #include "git2/types.h" diff --git a/include/git2/threads.h b/include/git2/sys/openssl.h index c0c3898d9..ad05e6ca8 100644 --- a/include/git2/threads.h +++ b/include/git2/sys/openssl.h @@ -4,37 +4,35 @@ * This file is part of libgit2, distributed under the GNU GPL v2 with * a Linking Exception. For full terms see the included COPYING file. */ -#ifndef INCLUDE_git_threads_h__ -#define INCLUDE_git_threads_h__ +#ifndef INCLUDE_git_openssl_h__ +#define INCLUDE_git_openssl_h__ #include "common.h" -/** - * @file git2/threads.h - * @brief Library level thread functions - * @defgroup git_thread Threading functions - * @ingroup Git - * @{ - */ GIT_BEGIN_DECL /** * Initialize the OpenSSL locks * * OpenSSL requires the application to determine how it performs - * locking. This is a convenience function which libgit2 provides for + * locking. + * + * This is a last-resort convenience function which libgit2 provides for * allocating and initializing the locks as well as setting the * locking function to use the system's native locking functions. * * The locking function will be cleared and the memory will be freed * when you call git_threads_sutdown(). * + * If your programming language has an OpenSSL package/bindings, it + * likely sets up locking. You should very strongly prefer that over + * this function. + * * @return 0 on success, -1 if there are errors or if libgit2 was not * built with OpenSSL and threading support. */ GIT_EXTERN(int) git_openssl_set_locking(void); -/** @} */ GIT_END_DECL #endif |