suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs for `dump-memory-stats'

Browse Source
This commit is contained in:
Matthew Flatt 2012-04-06 11:33:12 -06:00
parent 351e82735b
commit 971bee1d4b
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
collects/scribblings/reference/memory.scrbl
View File

@ -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.}