summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2021-11-11 00:30:40 +0100
committerJosh Triplett <josh@joshtriplett.org>2021-11-11 00:30:40 +0100
commit644c763b761eca2653b567515cc4b59262d58428 (patch)
tree43d67d3443c70af6be3f2ac8940425715d0fa7b6
parent44ec8b5cdf960cfeb66284a3cd5bdd8c14aefedf (diff)
downloadlibgit2-644c763b761eca2653b567515cc4b59262d58428.tar.gz
Document that `git_odb` is thread-safe
Commit 4ae41f9c639d246d34dac89c3f1d9451c9cfa8d3 made `git_odb` race-free, and added internal locking. Update `docs/threading.md` accordingly, so that APIs built atop libgit2 (e.g. language bindings) can count on this.
-rw-r--r--docs/threading.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/threading.md b/docs/threading.md
index ddfaf7ae5..de085c807 100644
--- a/docs/threading.md
+++ b/docs/threading.md
@@ -21,6 +21,9 @@ There are some objects which are read-only/immutable and are thus safe
to share across threads, such as references and configuration
snapshots.
+The `git_odb` object uses locking internally, and is thread-safe to use from
+multiple threads simultaneously.
+
Error messages
--------------