factor/extra/tools/memory/memory-docs.factor

26 lines
860 B
Factor
Raw Normal View History

2007-09-20 18:09:08 -04:00
USING: help.markup help.syntax memory ;
IN: tools.memory
ARTICLE: "tools.memory" "Object memory tools"
"You can print object heap status information:"
{ $subsection room. }
{ $subsection heap-stats. }
{ $subsection heap-stats }
{ $see-also "memory" } ;
ABOUT: "tools.memory"
HELP: room.
{ $description "Prints an overview of memory usage broken down by generation and zone." } ;
{ data-room code-room room. } related-words
HELP: heap-stats
{ $values { "counts" "an assoc mapping class words to integers" } { "sizes" "an assoc mapping class words to integers" } }
{ $description "Outputs a pair of assocs holding class instance counts and instance memory usage, respectively." } ;
HELP: heap-stats.
{ $description "For each class, prints the number of instances and total memory consumed by those instances." } ;
{ heap-stats heap-stats. } related-words