From de15a0d42a77c427cadf38d4c83f655263e330f6 Mon Sep 17 00:00:00 2001
From: rjung <rjung@13f79535-47bb-0310-9956-ffa450edef68>
Date: Wed, 24 Feb 2010 11:35:58 +0000
Subject: [PATCH] Add remark about reliability of System.gc() to manager
 diagnostics docs.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@915757 13f79535-47bb-0310-9956-ffa450edef68
---
 webapps/docs/html-manager-howto.xml | 6 ++++++
 webapps/docs/manager-howto.xml      | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/webapps/docs/html-manager-howto.xml b/webapps/docs/html-manager-howto.xml
index d76af36f8..19d930102 100644
--- a/webapps/docs/html-manager-howto.xml
+++ b/webapps/docs/html-manager-howto.xml
@@ -558,6 +558,12 @@ with a profiler. The diagnostic uses additional functionality provided by the
 StandardHost implementation. It will not work if a custom host is used that
 does not extend StandardHost.</p>
 
+<p>Explicitely triggering a full garbage collection from Java Code is documented
+to be unreliable. Furthermore, depending on the JVM used, there are options to
+disable explicit GC triggering, like <code>-XX:+DisableExplicitGC</code>.
+If you want to make sure, that the diagnostics were successfully running a full GC,
+you will need to check using tools like GC logging, JConsole or simlar.</p>
+
 </section>
 
 <section name="Server Information">
diff --git a/webapps/docs/manager-howto.xml b/webapps/docs/manager-howto.xml
index 274aa24b1..c1c10dd55 100644
--- a/webapps/docs/manager-howto.xml
+++ b/webapps/docs/manager-howto.xml
@@ -908,6 +908,12 @@ with a profiler. The diagnostic uses additional functionality provided by the
 StandardHost implementation. It will not work if a custom host is used that
 does not extend StandardHost.</p>
 
+<p>Explicitely triggering a full garbage collection from Java Code is documented
+to be unreliable. Furthermore, depending on the JVM used, there are options to
+disable explicit GC triggering, like <code>-XX:+DisableExplicitGC</code>.
+If you want to make sure, that the diagnostics were successfully running a full GC,
+you will need to check using tools like GC logging, JConsole or simlar.</p>
+
 <p>If this command succeeds, you will see a response like this:</p>
 <source>
 /leaking-webapp
-- 
2.11.0