Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=51649

Document ThreadLocalLeakPreventionListener

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1157015 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/webapps/docs/config/listeners.xml b/webapps/docs/config/listeners.xml
index 207a5f1..8d148e4 100644 (file)
--- a/webapps/docs/config/listeners.xml
+++ b/webapps/docs/config/listeners.xml
@@ -292,6 +292,22 @@
 
   </subsection>
 
+  <subsection name="ThreadLocal Leak Prevention Listener (org.apache.catalina.core.ThreadLocalLeakPreventionListener)">
+
+    <p>The <strong>ThreadLocal Leak Prevention Listener</strong> triggers the
+    renewal of threads in Executor pools when a
+    <a href="context.html">Context</a>is being stopped to avoid thread-local
+    related memory leaks. Active threads will be renewed one by one when they
+    come back to the pool after executing their task.</p>
+
+    <p>This listener must only be nested within <a href="server.html">Server</a>
+    elements.</p>
+
+    <p>No additional attributes are supported by the <strong>ThreadLocal Leak
+    Prevention Listener</strong>.</p>
+
+  </subsection>
+
 </section>
 
 <section name="Additional Implementations">