From: Justin Pettit <jpettit@nicira.com>
Date: Wed, 7 Apr 2010 21:51:18 +0000 (-0700)
Subject: leak-checker: Document "--leak-limit" option
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f0c689263a0424c83663b8466a64a051a012c757;p=openvswitch

leak-checker: Document "--leak-limit" option
---

diff --git a/lib/leak-checker.man b/lib/leak-checker.man
index 7b376e1a..beba9e13 100644
--- a/lib/leak-checker.man
+++ b/lib/leak-checker.man
@@ -1,7 +1,15 @@
 .TP
-\fB--check-leaks=\fIfile\fR
+\fB\-\-check\-leaks=\fIfile\fR
 .
 Logs information about memory allocation and deallocation to
 \fIfile\fR, to allow for debugging memory leaks in \fB\*(PN\fR.  This
 option slows down \fB\*(PN\fR considerably, so it should only be used
-when a memory leak is suspected.
+when a memory leak is suspected.  Use the \fBovs\-parse\-leaks\fR script
+to interpret the leak file.
+.TP
+\fB\-\-leak\-limit=\fIsize\fR
+.
+Limits size of the leak file as specified by \fB\-\-check\-leaks\fR to 
+\fIsize\fR bytes.  Finding leaks sometimes requires allowing the leak 
+file to grow very large, up to 1GB.  By default, files are limited
+to 10MB.