kmemleak: allow freeing internal objects after kmemleak was disabled

[linux-2.6-block.git] / Documentation / kmemleak.txt

diff --git a/Documentation/kmemleak.txt b/Documentation/kmemleak.txt
index b6e39739a36d01e2da283e806de131a4bc18890d..6c18be97f3dda4151bdf02fed1db250669e255e5 100644 (file)
--- a/Documentation/kmemleak.txt
+++ b/Documentation/kmemleak.txt
@@ -53,7 +53,8 @@ Memory scanning parameters can be modified at run-time by writing to the
                  (default 600, 0 to stop the automatic scanning)
   scan         - trigger a memory scan
   clear                - clear list of current memory leak suspects, done by
-                 marking all current reported unreferenced objects grey
+                 marking all current reported unreferenced objects grey,
+                 or free all kmemleak objects if kmemleak has been disabled.
   dump=<addr>  - dump information about the object found at <addr>
 
 Kmemleak can also be disabled at boot-time by passing "kmemleak=off" on
@@ -120,6 +121,18 @@ Then as usual to get your report with:
 
   # cat /sys/kernel/debug/kmemleak
 
+Freeing kmemleak internal objects
+---------------------------------
+
+To allow access to previosuly found memory leaks after kmemleak has been
+disabled by the user or due to an fatal error, internal kmemleak objects
+won't be freed when kmemleak is disabled, and those objects may occupy
+a large part of physical memory.
+
+In this situation, you may reclaim memory with:
+
+  # echo clear > /sys/kernel/debug/kmemleak
+
 Kmemleak API
 ------------