aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2017-12-16 20:35:14 +0200
committerGitHub <noreply@github.com>2017-12-16 20:35:14 +0200
commit9e5af7c3b77f81a7d1720073dca600e51fe9962d (patch)
tree2f110743af935cdf56129e86b77e77a7e150dbb2 /doc
parent02dade46c0f860abf11f1b173b808ad502b44842 (diff)
parent6c78910011c5d10b9fcb95b6fdd038f4aa9bf74d (diff)
downloadjansson-9e5af7c3b77f81a7d1720073dca600e51fe9962d.zip
jansson-9e5af7c3b77f81a7d1720073dca600e51fe9962d.tar.gz
jansson-9e5af7c3b77f81a7d1720073dca600e51fe9962d.tar.bz2
Merge pull request #374 from coreyfarrell/always-steal
json_pack: Enable more complete stealing of references.
Diffstat (limited to 'doc')
-rw-r--r--doc/apiref.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst
index 7afeb21..a8cf8d6 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -1564,7 +1564,10 @@ type whose address should be passed.
Store a JSON value with no conversion to a :type:`json_t` pointer.
``O`` (any value) [json_t \*]
- Like ``O``, but the JSON value's reference count is incremented.
+ Like ``o``, but the JSON value's reference count is incremented.
+ Storage pointers should be initialized NULL before using unpack.
+ The caller is responsible for releasing all references incremented
+ by unpack, even when an error occurs.
``[fmt]`` (array)
Convert each item in the JSON array according to the inner format