aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <saghul@gmail.com>2014-09-30 09:14:56 +0200
committerSaúl Ibarra Corretgé <saghul@gmail.com>2014-09-30 09:14:56 +0200
commit00df3ec75bd30a98226dc5758a142e49f7c434f8 (patch)
tree30934fd3a8b82d0bb23e7065932154e2cc8227c0 /docs/src
parent9486e462fce7754c72933118166602c938e344a7 (diff)
downloadlibuv-00df3ec75bd30a98226dc5758a142e49f7c434f8.tar.gz
libuv-00df3ec75bd30a98226dc5758a142e49f7c434f8.zip
doc: clarify uv_loop_t.data field lifetime
Fixes #1503
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/loop.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/src/loop.rst b/docs/src/loop.rst
index bc2afe2f..c63ef7eb 100644
--- a/docs/src/loop.rst
+++ b/docs/src/loop.rst
@@ -38,7 +38,9 @@ Public members
.. c:member:: void* uv_loop_t.data
- Space for user-defined arbitrary data. libuv does not use this field.
+ Space for user-defined arbitrary data. libuv does not use this field. libuv does, however,
+ initialize it to NULL in :c:func:`uv_loop_init`, and it poisons the value (on debug builds)
+ on :c:func:`uv_loop_close`.
API