From 971bee1d4b508b6be7d27b6144d719643a8f6a08 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Fri, 6 Apr 2012 11:33:12 -0600 Subject: [PATCH] fix docs for `dump-memory-stats' --- collects/scribblings/reference/memory.scrbl | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/collects/scribblings/reference/memory.scrbl b/collects/scribblings/reference/memory.scrbl index 0eccfee8ac..63424eccd8 100644 --- a/collects/scribblings/reference/memory.scrbl +++ b/collects/scribblings/reference/memory.scrbl @@ -240,7 +240,13 @@ When Racket is compiled without support for memory accounting, the estimate is the same (i.e., all memory) for any individual custodian; see also @racket[custodian-memory-accounting-available?].} -@defproc[(dump-memory-stats) any]{ +@defproc[(dump-memory-stats [v any/c] ...) any]{ -Dumps information about memory usage to the (low-level) standard -output port.} +Dumps information about memory usage to the low-level error port + or console. + +Various combinations of @racket[v] arguments can control the +information in a dump. The information that is available depends on +your Racket build; check the end of a dump from a particular build to +see if it offers additional information; otherwise, all @racket[v]s are +ignored.}