aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2020-11-19 17:26:06 +0200
committerPetri Lehtinen <petri@digip.org>2020-11-19 17:27:03 +0200
commit55ea6d44dd63c8e591d23545ba298ffe42305191 (patch)
treec86ef09092d2c57b32a04ca466ba5f3c89323e06
parent9a0fc069bfa2a7111ae3ca2803baff778f0626f7 (diff)
downloadjansson-55ea6d44dd63c8e591d23545ba298ffe42305191.zip
jansson-55ea6d44dd63c8e591d23545ba298ffe42305191.tar.gz
jansson-55ea6d44dd63c8e591d23545ba298ffe42305191.tar.bz2
doc: Rename "Portability" to "Thread-safety"
Fixes #545
-rw-r--r--doc/apiref.rst3
-rw-r--r--doc/index.rst2
-rw-r--r--doc/threadsafety.rst (renamed from doc/portability.rst)11
3 files changed, 6 insertions, 10 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst
index 8ef190e..db58a8f 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -933,8 +933,7 @@ inserted to the object.
:func:`json_object()`, either explicit or implicit. If this
function is not called by the user, the first call to
:func:`json_object()` (either explicit or implicit) seeds the hash
- function. See :ref:`portability-thread-safety` for notes on thread
- safety.
+ function. See :ref:`thread-safety` for notes on thread safety.
If repeatable results are required, for e.g. unit tests, the hash
function can be "unrandomized" by calling :func:`json_object_seed`
diff --git a/doc/index.rst b/doc/index.rst
index 1f3f8ef..c679f40 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -41,7 +41,7 @@ Contents
upgrading
tutorial
conformance
- portability
+ threadsafety
apiref
changes
diff --git a/doc/portability.rst b/doc/threadsafety.rst
index f8d81cd..bea5978 100644
--- a/doc/portability.rst
+++ b/doc/threadsafety.rst
@@ -1,11 +1,8 @@
-***********
-Portability
-***********
-
-.. _portability-thread-safety:
-
+*************
Thread safety
--------------
+*************
+
+.. _thread-safety:
Jansson as a library is thread safe and has no mutable global state.
The only exceptions are the hash function seed and memory allocation