global: clarify correct usage of git_libgit2_init with threads
#3972
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`git_libgit2_init` needs to be called is a single-threaded context first, as it also sets up threading-related data structures. While the fact that it does so is mentioned in the function's documentation, we do not mention the consequences. Improve the documentation so that we explicitly note that `git_libgit2_init` shall be called before making use of threads.
This was referenced Oct 27, 2016
|
Closing in favor of #3974 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
git_libgit2_initneeds to be called is a single-threadedcontext first, as it also sets up threading-related data
structures. While the fact that it does so is mentioned in the
function's documentation, we do not mention the consequences.
Improve the documentation so that we explicitly note that
git_libgit2_initshall be called before making use of threads.Refs #3969