[ovs-dev] [PATCH] leak-checker: Document "--leak-limit" option

Ben Pfaff blp at nicira.com
Thu Apr 8 16:33:06 UTC 2010


On Wed, Apr 07, 2010 at 06:22:43PM -0700, Justin Pettit wrote:
> diff --git a/lib/leak-checker.man b/lib/leak-checker.man
> index 7b376e1..eb64869 100644
> --- a/lib/leak-checker.man
> +++ b/lib/leak-checker.man
> @@ -5,3 +5,8 @@ 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.
> +.TP
> +\fB--leak-limit=\fIsize\fR
> +.
> +Limits size of the leak file as specified by \fB--check-leaks\fR to 
> +\fIsize\fR bytes.  By default, files are limited to 10MB.

Thank you.

The "-"s should be prefixed by \.  I know that we are not consistent
about this now, but I try not to add any more mistakes.

I would add another sentence: "Finding leaks sometimes requires allowing
the leak file to grow very large, up to 1GB."

I would add a sentence to the --check-leaks documentation: "Use the
\fBovs-parse-leaks\fR script to interpret the leak file."




More information about the dev mailing list