Commit fb2f3a76aaf9d76b947ca7527797e0eb0b5d057f

Edward Thomson 2015-02-27T00:37:20

Merge pull request #2922 from ethomson/more_explaining_threads_is_more_better README: provide some more explanation about TLS

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
diff --git a/README.md b/README.md
index b9a42d7..8829242 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,10 @@ before calling any other libgit2 functions. You can call this function many time
 
     git_libgit2_shutdown();
 
-will free the resources.
+will free the resources.  Note that if you have worker threads, you should
+call `git_libgit2_shutdown` *after* those threads have exited.  If you
+require assistance coordinating this, simply have the worker threads call
+`git_libgit2_init` at startup and `git_libgit2_shutdown` at shutdown.
 
 Threading
 =========