summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorQi Wang <interwq@gwu.edu>2017-10-06 22:51:35 (GMT)
committerQi Wang <interwq@gmail.com>2017-10-11 16:52:04 (GMT)
commitfc83de0384a2ad87cf5059d4345acf014c77e6e4 (patch)
tree47e90b6685a6406e0eec7b7519e207867fcf2e40 /doc
parent7e74093c96c019ce52aee9a03fc745647d79ca5f (diff)
downloadjemalloc-fc83de0384a2ad87cf5059d4345acf014c77e6e4.zip
jemalloc-fc83de0384a2ad87cf5059d4345acf014c77e6e4.tar.gz
jemalloc-fc83de0384a2ad87cf5059d4345acf014c77e6e4.tar.bz2
Document the potential issues about opt.background_thread.
Diffstat (limited to 'doc')
-rw-r--r--doc/jemalloc.xml.in9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/jemalloc.xml.in b/doc/jemalloc.xml.in
index dda9a73..8151b5b 100644
--- a/doc/jemalloc.xml.in
+++ b/doc/jemalloc.xml.in
@@ -1010,9 +1010,12 @@ mallctl("arena." STRINGIFY(MALLCTL_ARENAS_ALL) ".decay",
(<type>const bool</type>)
<literal>r-</literal>
</term>
- <listitem><para>Internal background worker threads enabled/disabled. See
- <link linkend="background_thread">background_thread</link> for dynamic
- control options and details. This option is disabled by
+ <listitem><para>Internal background worker threads enabled/disabled.
+ Because of potential circular dependencies, enabling background thread
+ using this option may cause crash or deadlock during initialization. For
+ a reliable way to use this feature, see <link
+ linkend="background_thread">background_thread</link> for dynamic control
+ options and details. This option is disabled by
default.</para></listitem>
</varlistentry>